Update documentation

xiaoyuxie-vico · Jan 14, 2024 · b6056e8 · b6056e8
1 parent 252a538
commit b6056e8
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 68 deletions.
diff --git a/FNO/FNO-1D/FNO-1D.html b/FNO/FNO-1D/FNO-1D.html
@@ -359,39 +359,32 @@ <h1 class="site-logo" id="site-title">Scientific Machine Learning</h1>
     </div>
     <nav id="bd-toc-nav" aria-label="Page">
         <ul class="visible nav section-nav flex-column">
- <li class="toc-h1 nav-item toc-entry">
-  <a class="reference internal nav-link" href="#">
-   Hands-on tutorials - Fourier Neural Operator for 1D Burgers equation
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#define-fno-model">
+   Define FNO model
+  </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#configuration">
+   Configuration
   </a>
-  <ul class="visible nav section-nav flex-column">
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#define-fno-model">
-     Define FNO model
-    </a>
-   </li>
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#configuration">
-     Configuration
-    </a>
-   </li>
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#dataset-preparation">
-     Dataset preparation
-    </a>
-   </li>
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#model-training">
-     Model training
-    </a>
-   </li>
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#model-evaluation">
-     Model evaluation
-    </a>
-   </li>
-  </ul>
  </li>
- <li class="toc-h1 nav-item toc-entry">
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#dataset-preparation">
+   Dataset preparation
+  </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#model-training">
+   Model training
+  </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#model-evaluation">
+   Model evaluation
+  </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
   <a class="reference internal nav-link" href="#reference">
    Reference
   </a>
@@ -415,39 +408,32 @@ <h2> Contents </h2>
                         </div>
                         <nav aria-label="Page">
                             <ul class="visible nav section-nav flex-column">
- <li class="toc-h1 nav-item toc-entry">
-  <a class="reference internal nav-link" href="#">
-   Hands-on tutorials - Fourier Neural Operator for 1D Burgers equation
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#define-fno-model">
+   Define FNO model
+  </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#configuration">
+   Configuration
   </a>
-  <ul class="visible nav section-nav flex-column">
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#define-fno-model">
-     Define FNO model
-    </a>
-   </li>
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#configuration">
-     Configuration
-    </a>
-   </li>
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#dataset-preparation">
-     Dataset preparation
-    </a>
-   </li>
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#model-training">
-     Model training
-    </a>
-   </li>
-   <li class="toc-h2 nav-item toc-entry">
-    <a class="reference internal nav-link" href="#model-evaluation">
-     Model evaluation
-    </a>
-   </li>
-  </ul>
  </li>
- <li class="toc-h1 nav-item toc-entry">
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#dataset-preparation">
+   Dataset preparation
+  </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#model-training">
+   Model training
+  </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+  <a class="reference internal nav-link" href="#model-evaluation">
+   Model evaluation
+  </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
   <a class="reference internal nav-link" href="#reference">
    Reference
   </a>
@@ -862,9 +848,8 @@ <h2>Model evaluation<a class="headerlink" href="#model-evaluation" title="Permal
 </div>
 </div>
 </section>
-</section>
-<section class="tex2jax_ignore mathjax_ignore" id="reference">
-<h1>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">#</a></h1>
+<section id="reference">
+<h2>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">#</a></h2>
 <ul class="simple">
 <li><p>FNO paper: Li, Z., Kovachki, N., Azizzadenesheli, K., Liu, B., Bhattacharya, K., Stuart, A., &amp; Anandkumar, A. (2020). Fourier neural operator for parametric partial differential equations. arXiv preprint arXiv:2010.08895</p></li>
 <li><p>FNO official github: <a class="reference external" href="https://github.com/neuraloperator/neuraloperator/?tab=readme-ov-file">https://github.com/neuraloperator/neuraloperator/?tab=readme-ov-file</a></p></li>
@@ -876,6 +861,7 @@ <h1>Reference<a class="headerlink" href="#reference" title="Permalink to this he
 <li><p>Wikipedia: <a class="reference external" href="https://en.wikipedia.org/wiki/Neural_operators">https://en.wikipedia.org/wiki/Neural_operators</a></p></li>
 <li><p>Julia: <a class="reference external" href="https://docs.sciml.ai/NeuralOperators/stable/introduction/">https://docs.sciml.ai/NeuralOperators/stable/introduction/</a></p></li>
 </ul>
+</section>
 </section>
 
     <script type="text/x-thebe-config">

diff --git a/_sources/FNO/FNO-1D/FNO-1D.ipynb b/_sources/FNO/FNO-1D/FNO-1D.ipynb
@@ -496,7 +496,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Reference\n",
+    "### Reference\n",
     "\n",
     "- FNO paper: Li, Z., Kovachki, N., Azizzadenesheli, K., Liu, B., Bhattacharya, K., Stuart, A., & Anandkumar, A. (2020). Fourier neural operator for parametric partial differential equations. arXiv preprint arXiv:2010.08895\n",
     "- FNO official github: https://github.com/neuraloperator/neuraloperator/?tab=readme-ov-file\n",

diff --git a/intro.html b/intro.html
@@ -337,7 +337,6 @@ <h1>Welcome to Scientific Machine Learning Book<a class="headerlink" href="#welc
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Part 1. Fourier Neural Operator</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="FNO/FNO-1D/FNO-1D.html">Hands-on tutorials - Fourier Neural Operator for 1D Burgers equation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="FNO/FNO-1D/FNO-1D.html#reference">Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="FNO/FNO-2D/FNO-2D.html">Hands-on tutorials - Fourier Neural Operator for 2D Example</a></li>
 </ul>
 </div>