[CI] Full Doc Build: 40ef71c

NVIDIA · Apr 15, 2024 · d3fcfe3 · d3fcfe3
1 parent 4c3e162
commit d3fcfe3
Show file tree

Hide file tree

Showing 125 changed files with 3,782 additions and 1,252 deletions.
diff --git a/v/0.1.0/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip b/v/0.1.0/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip
diff --git a/v/0.1.0/_downloads/fb625db3c50d423b1b7881136ffdeec8/examples_jupyter.zip b/v/0.1.0/_downloads/fb625db3c50d423b1b7881136ffdeec8/examples_jupyter.zip
diff --git a/v/0.1.0/_images/sphx_glr_01_custom_prognostic_001.png b/v/0.1.0/_images/sphx_glr_01_custom_prognostic_001.png
diff --git a/v/0.1.0/_images/sphx_glr_01_custom_prognostic_001_2_00x.png b/v/0.1.0/_images/sphx_glr_01_custom_prognostic_001_2_00x.png
diff --git a/v/0.1.0/_images/sphx_glr_01_custom_prognostic_thumb.png b/v/0.1.0/_images/sphx_glr_01_custom_prognostic_thumb.png
diff --git a/v/0.1.0/_images/sphx_glr_02_custom_diagnostic_001.png b/v/0.1.0/_images/sphx_glr_02_custom_diagnostic_001.png
diff --git a/v/0.1.0/_images/sphx_glr_02_custom_diagnostic_001_2_00x.png b/v/0.1.0/_images/sphx_glr_02_custom_diagnostic_001_2_00x.png
diff --git a/v/0.1.0/_images/sphx_glr_02_custom_diagnostic_thumb.png b/v/0.1.0/_images/sphx_glr_02_custom_diagnostic_thumb.png
diff --git a/v/0.1.0/_images/sphx_glr_02_ensemble_workflow_001.png b/v/0.1.0/_images/sphx_glr_02_ensemble_workflow_001.png
diff --git a/v/0.1.0/_images/sphx_glr_02_ensemble_workflow_001_2_00x.png b/v/0.1.0/_images/sphx_glr_02_ensemble_workflow_001_2_00x.png
diff --git a/v/0.1.0/_images/sphx_glr_02_ensemble_workflow_thumb.png b/v/0.1.0/_images/sphx_glr_02_ensemble_workflow_thumb.png
diff --git a/v/0.1.0/_images/sphx_glr_05_model_perturbation_hook_001.png b/v/0.1.0/_images/sphx_glr_05_model_perturbation_hook_001.png
diff --git a/v/0.1.0/_images/sphx_glr_05_model_perturbation_hook_001_2_00x.png b/v/0.1.0/_images/sphx_glr_05_model_perturbation_hook_001_2_00x.png
diff --git a/v/0.1.0/_images/sphx_glr_05_model_perturbation_hook_thumb.png b/v/0.1.0/_images/sphx_glr_05_model_perturbation_hook_thumb.png
diff --git a/v/0.1.0/_images/sphx_glr_06_seasonal_statistics_001.png b/v/0.1.0/_images/sphx_glr_06_seasonal_statistics_001.png
diff --git a/v/0.1.0/_images/sphx_glr_06_seasonal_statistics_001_2_00x.png b/v/0.1.0/_images/sphx_glr_06_seasonal_statistics_001_2_00x.png
diff --git a/v/0.1.0/_images/sphx_glr_06_seasonal_statistics_thumb.png b/v/0.1.0/_images/sphx_glr_06_seasonal_statistics_thumb.png
diff --git a/v/0.1.0/_modules/earth2studio/io/kv.html b/v/0.1.0/_modules/earth2studio/io/kv.html
@@ -479,6 +479,8 @@ <h1>Source code for earth2studio.io.kv</h1><div class="highlight"><pre>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Return an iterator over KV store member names.&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">|</span> <span class="bp">self</span><span class="o">.</span><span class="n">coords</span><span class="p">)</span><span class="o">.</span><span class="fm">__iter__</span><span class="p">()</span>
 
+<div class="viewcode-block" id="KVBackend.add_array">
+<a class="viewcode-back" href="../../../modules/generated/io/earth2studio.io.KVBackend.html#earth2studio.io.KVBackend.add_array">[docs]</a>
     <span class="k">def</span> <span class="nf">add_array</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">coords</span><span class="p">:</span> <span class="n">CoordSystem</span><span class="p">,</span>
@@ -529,7 +531,8 @@ <h1>Source code for earth2studio.io.kv</h1><div class="highlight"><pre>
                 <span class="n">shape</span> <span class="o">=</span> <span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">coords</span><span class="o">.</span><span class="n">values</span><span class="p">()]</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">torch</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span>
                     <span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">torch</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">device</span>
-                <span class="p">)</span>
+                <span class="p">)</span></div>
+
 
 <div class="viewcode-block" id="KVBackend.write">
 <a class="viewcode-back" href="../../../modules/generated/io/earth2studio.io.KVBackend.html#earth2studio.io.KVBackend.write">[docs]</a>

diff --git a/v/0.1.0/_modules/earth2studio/io/netcdf4.html b/v/0.1.0/_modules/earth2studio/io/netcdf4.html
@@ -539,6 +539,8 @@ <h1>Source code for earth2studio.io.netcdf4</h1><div class="highlight"><pre>
         <span class="k">else</span><span class="p">:</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Error, only 1-dimension coordinates are supported.&quot;</span><span class="p">)</span>
 
+<div class="viewcode-block" id="NetCDF4Backend.add_array">
+<a class="viewcode-back" href="../../../modules/generated/io/earth2studio.io.NetCDF4Backend.html#earth2studio.io.NetCDF4Backend.add_array">[docs]</a>
     <span class="k">def</span> <span class="nf">add_array</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">coords</span><span class="p">:</span> <span class="n">CoordSystem</span><span class="p">,</span>
@@ -590,7 +592,8 @@ <h1>Source code for earth2studio.io.netcdf4</h1><div class="highlight"><pre>
             <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="n">createVariable</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">dtype</span><span class="p">,</span> <span class="nb">list</span><span class="p">(</span><span class="n">coords</span><span class="p">))</span>
 
             <span class="k">if</span> <span class="n">di</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
-                <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">[</span><span class="n">name</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">di</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">[</span><span class="n">name</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">di</span></div>
+
 
 <div class="viewcode-block" id="NetCDF4Backend.write">
 <a class="viewcode-back" href="../../../modules/generated/io/earth2studio.io.NetCDF4Backend.html#earth2studio.io.NetCDF4Backend.write">[docs]</a>

diff --git a/v/0.1.0/_modules/earth2studio/io/zarr.html b/v/0.1.0/_modules/earth2studio/io/zarr.html
@@ -489,6 +489,8 @@ <h1>Source code for earth2studio.io.zarr</h1><div class="highlight"><pre>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Return an iterator over Zarr Group member names.&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="o">.</span><span class="fm">__iter__</span><span class="p">()</span>
 
+<div class="viewcode-block" id="ZarrBackend.add_array">
+<a class="viewcode-back" href="../../../modules/generated/io/earth2studio.io.ZarrBackend.html#earth2studio.io.ZarrBackend.add_array">[docs]</a>
     <span class="k">def</span> <span class="nf">add_array</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">coords</span><span class="p">:</span> <span class="n">CoordSystem</span><span class="p">,</span>
@@ -558,7 +560,8 @@ <h1>Source code for earth2studio.io.zarr</h1><div class="highlight"><pre>
             <span class="k">if</span> <span class="n">di</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">[</span><span class="n">name</span><span class="p">][:]</span> <span class="o">=</span> <span class="n">di</span>
 
-            <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">attrs</span><span class="p">[</span><span class="s2">&quot;_ARRAY_DIMENSIONS&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">coords</span><span class="p">)</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">attrs</span><span class="p">[</span><span class="s2">&quot;_ARRAY_DIMENSIONS&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">coords</span><span class="p">)</span></div>
+
 
 <div class="viewcode-block" id="ZarrBackend.write">
 <a class="viewcode-back" href="../../../modules/generated/io/earth2studio.io.ZarrBackend.html#earth2studio.io.ZarrBackend.write">[docs]</a>

diff --git a/v/0.1.0/_modules/earth2studio/statistics/moments.html b/v/0.1.0/_modules/earth2studio/statistics/moments.html
@@ -473,6 +473,8 @@ <h1>Source code for earth2studio.statistics.moments</h1><div class="highlight"><
     <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
         <span class="k">return</span> <span class="s2">&quot;_&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reduction_dimensions</span> <span class="o">+</span> <span class="p">[</span><span class="s2">&quot;mean&quot;</span><span class="p">])</span>
 
+<div class="viewcode-block" id="mean.__call__">
+<a class="viewcode-back" href="../../../modules/generated/statistics/earth2studio.statistics.mean.html#earth2studio.statistics.mean.__call__">[docs]</a>
     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">coords</span><span class="p">:</span> <span class="n">CoordSystem</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">CoordSystem</span><span class="p">]:</span>
@@ -517,6 +519,7 @@ <h1>Source code for earth2studio.statistics.moments</h1><div class="highlight"><
 
             <span class="bp">self</span><span class="o">.</span><span class="n">n</span> <span class="o">+=</span> <span class="n">weights_sum</span>
             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">sum</span> <span class="o">/</span> <span class="bp">self</span><span class="o">.</span><span class="n">n</span><span class="p">,</span> <span class="n">output_coords</span></div>
+</div>
 
 
 
@@ -566,6 +569,8 @@ <h1>Source code for earth2studio.statistics.moments</h1><div class="highlight"><
     <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
         <span class="k">return</span> <span class="s2">&quot;_&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reduction_dimensions</span> <span class="o">+</span> <span class="p">[</span><span class="s2">&quot;variance&quot;</span><span class="p">])</span>
 
+<div class="viewcode-block" id="variance.__call__">
+<a class="viewcode-back" href="../../../modules/generated/statistics/earth2studio.statistics.variance.html#earth2studio.statistics.variance.__call__">[docs]</a>
     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">coords</span><span class="p">:</span> <span class="n">CoordSystem</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">CoordSystem</span><span class="p">]:</span>
@@ -627,6 +632,7 @@ <h1>Source code for earth2studio.statistics.moments</h1><div class="highlight"><
                 <span class="bp">self</span><span class="o">.</span><span class="n">sum2</span> <span class="o">/</span> <span class="n">torch</span><span class="o">.</span><span class="n">maximum</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">n</span> <span class="o">-</span> <span class="mf">1.0</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">tensor</span><span class="p">(</span><span class="mf">1.0</span><span class="p">)),</span>
                 <span class="n">output_coords</span><span class="p">,</span>
             <span class="p">)</span></div>
+</div>
 
 
 

diff --git a/v/0.1.0/_modules/earth2studio/statistics/rmse.html b/v/0.1.0/_modules/earth2studio/statistics/rmse.html
@@ -471,6 +471,8 @@ <h1>Source code for earth2studio.statistics.rmse</h1><div class="highlight"><pre
     <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
         <span class="k">return</span> <span class="s2">&quot;_&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reduction_dimensions</span> <span class="o">+</span> <span class="p">[</span><span class="s2">&quot;rmse&quot;</span><span class="p">])</span>
 
+<div class="viewcode-block" id="rmse.__call__">
+<a class="viewcode-back" href="../../../modules/generated/statistics/earth2studio.statistics.rmse.html#earth2studio.statistics.rmse.__call__">[docs]</a>
     <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">x</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span>
@@ -505,6 +507,7 @@ <h1>Source code for earth2studio.statistics.rmse</h1><div class="highlight"><pre
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">mse</span><span class="p">,</span> <span class="n">output_coords</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mean</span><span class="p">((</span><span class="n">x</span> <span class="o">-</span> <span class="n">y</span><span class="p">)</span> <span class="o">**</span> <span class="mi">2</span><span class="p">,</span> <span class="n">x_coords</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">torch</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="n">mse</span><span class="p">),</span> <span class="n">output_coords</span></div>
+</div>
 
 </pre></div>
 

diff --git a/v/0.1.0/_modules/earth2studio/utils/coords.html b/v/0.1.0/_modules/earth2studio/utils/coords.html
@@ -691,6 +691,8 @@ <h1>Source code for earth2studio.utils.coords</h1><div class="highlight"><pre>
 
 
 
+<div class="viewcode-block" id="extract_coords">
+<a class="viewcode-back" href="../../../modules/generated/utils/earth2studio.utils.coords.extract_coords.html#earth2studio.utils.coords.extract_coords">[docs]</a>
 <span class="k">def</span> <span class="nf">extract_coords</span><span class="p">(</span>
     <span class="n">x</span><span class="p">:</span> <span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">,</span> <span class="n">coords</span><span class="p">:</span> <span class="n">CoordSystem</span><span class="p">,</span> <span class="n">dim</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;variable&quot;</span>
 <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="n">torch</span><span class="o">.</span><span class="n">Tensor</span><span class="p">],</span> <span class="n">CoordSystem</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">]:</span>
@@ -724,7 +726,8 @@ <h1>Source code for earth2studio.utils.coords</h1><div class="highlight"><pre>
     <span class="n">dim_index</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">reduced_coords</span><span class="p">)</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">dim</span><span class="p">)</span>
     <span class="n">values</span> <span class="o">=</span> <span class="n">reduced_coords</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">dim</span><span class="p">)</span>
     <span class="n">xs</span> <span class="o">=</span> <span class="p">[</span><span class="n">xi</span><span class="o">.</span><span class="n">squeeze</span><span class="p">(</span><span class="n">dim_index</span><span class="p">)</span> <span class="k">for</span> <span class="n">xi</span> <span class="ow">in</span> <span class="n">x</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">dim</span><span class="o">=</span><span class="n">dim_index</span><span class="p">)]</span>
-    <span class="k">return</span> <span class="n">xs</span><span class="p">,</span> <span class="n">reduced_coords</span><span class="p">,</span> <span class="n">values</span>
+    <span class="k">return</span> <span class="n">xs</span><span class="p">,</span> <span class="n">reduced_coords</span><span class="p">,</span> <span class="n">values</span></div>
+
 </pre></div>
 
                 </article>