Skip to content

Commit

Permalink
deploy: e4ec230
Browse files Browse the repository at this point in the history
  • Loading branch information
@otavioon
otavioon committed Feb 2, 2024
1 parent 3091230 commit 2cc2ffc
Show file tree
Hide file tree
Showing 11 changed files with 18 additions and 40 deletions.
9 changes: 1 addition & 8 deletions _sources/notebooks/04_using_experiments.ipynb.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Using Experiments\n",
"# 4. Using Experiments\n",
"\n",
"Although the process of training and evaluating models becomes easier due to the abstractions and facilities provided by this framework and Pytorch Lightning, we also standarize the way we conduct experiments, in order to allow for a more systematic and organized approach to the development of models.\n",
"\n",
Expand Down Expand Up @@ -892,13 +892,6 @@
" print(f\"Test on dataset {dataset} finished!\")"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
4 changes: 2 additions & 2 deletions experiments.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Contributing" href="contributing.html" />
<link rel="prev" title="Using Experiments" href="notebooks/04_using_experiments.html" />
<link rel="prev" title="4. Using Experiments" href="notebooks/04_using_experiments.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -88,7 +88,7 @@ <h1>Running Experiments<a class="headerlink" href="#running-experiments" title="
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="notebooks/04_using_experiments.html" class="btn btn-neutral float-left" title="Using Experiments" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="notebooks/04_using_experiments.html" class="btn btn-neutral float-left" title="4. Using Experiments" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h1>Welcome to SSLTools’s documentation!<a class="headerlink" href="#welcome-t
<li class="toctree-l2"><a class="reference internal" href="notebooks/01_structuring_input.html">1. Structuring the input</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/02_training_model.html">2. Training a Pytorch Lighning model</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/03_training_ssl_model.html">3. Training a self-supervised model (CPC)</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/04_using_experiments.html">Using Experiments</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/04_using_experiments.html">4. Using Experiments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="experiments.html">Running Experiments</a></li>
Expand Down
2 changes: 1 addition & 1 deletion notebooks/01_structuring_input.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
</li>
<li class="toctree-l2"><a class="reference internal" href="02_training_model.html">2. Training a Pytorch Lighning model</a></li>
<li class="toctree-l2"><a class="reference internal" href="03_training_ssl_model.html">3. Training a self-supervised model (CPC)</a></li>
<li class="toctree-l2"><a class="reference internal" href="04_using_experiments.html">Using Experiments</a></li>
<li class="toctree-l2"><a class="reference internal" href="04_using_experiments.html">4. Using Experiments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../experiments.html">Running Experiments</a></li>
Expand Down
2 changes: 1 addition & 1 deletion notebooks/02_training_model.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="03_training_ssl_model.html">3. Training a self-supervised model (CPC)</a></li>
<li class="toctree-l2"><a class="reference internal" href="04_using_experiments.html">Using Experiments</a></li>
<li class="toctree-l2"><a class="reference internal" href="04_using_experiments.html">4. Using Experiments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../experiments.html">Running Experiments</a></li>
Expand Down
6 changes: 3 additions & 3 deletions notebooks/03_training_ssl_model.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Using Experiments" href="04_using_experiments.html" />
<link rel="next" title="4. Using Experiments" href="04_using_experiments.html" />
<link rel="prev" title="2. Training a Pytorch Lighning model" href="02_training_model.html" />
</head>

Expand Down Expand Up @@ -69,7 +69,7 @@
<li class="toctree-l3"><a class="reference internal" href="#Next-steps">Next steps</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="04_using_experiments.html">Using Experiments</a></li>
<li class="toctree-l2"><a class="reference internal" href="04_using_experiments.html">4. Using Experiments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../experiments.html">Running Experiments</a></li>
Expand Down Expand Up @@ -800,7 +800,7 @@ <h2>Next steps<a class="headerlink" href="#Next-steps" title="Link to this headi
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="02_training_model.html" class="btn btn-neutral float-left" title="2. Training a Pytorch Lighning model" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="04_using_experiments.html" class="btn btn-neutral float-right" title="Using Experiments" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="04_using_experiments.html" class="btn btn-neutral float-right" title="4. Using Experiments" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
18 changes: 5 additions & 13 deletions notebooks/04_using_experiments.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Using Experiments &mdash; SSLTools documentation</title>
<title>4. Using Experiments &mdash; SSLTools documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=eafc0fe6" />
Expand Down Expand Up @@ -56,7 +56,7 @@
<li class="toctree-l2"><a class="reference internal" href="01_structuring_input.html">1. Structuring the input</a></li>
<li class="toctree-l2"><a class="reference internal" href="02_training_model.html">2. Training a Pytorch Lighning model</a></li>
<li class="toctree-l2"><a class="reference internal" href="03_training_ssl_model.html">3. Training a self-supervised model (CPC)</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Using Experiments</a><ul>
<li class="toctree-l2 current"><a class="current reference internal" href="#">4. Using Experiments</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#Experiment-Structure">Experiment Structure</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#The-Experiment-class">The <code class="docutils literal notranslate"><span class="pre">Experiment</span></code> class</a></li>
<li class="toctree-l4"><a class="reference internal" href="#The-LightningExperiment-class">The <code class="docutils literal notranslate"><span class="pre">LightningExperiment</span></code> class</a></li>
Expand Down Expand Up @@ -95,7 +95,7 @@
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../tutorials.html">Tutorials</a></li>
<li class="breadcrumb-item active">Using Experiments</li>
<li class="breadcrumb-item active">4. Using Experiments</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/notebooks/04_using_experiments.ipynb.txt" rel="nofollow"> View page source</a>
</li>
Expand All @@ -105,8 +105,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="Using-Experiments">
<h1>Using Experiments<a class="headerlink" href="#Using-Experiments" title="Link to this heading"></a></h1>
<section id="4.-Using-Experiments">
<h1>4. Using Experiments<a class="headerlink" href="#4.-Using-Experiments" title="Link to this heading"></a></h1>
<p>Although the process of training and evaluating models becomes easier due to the abstractions and facilities provided by this framework and Pytorch Lightning, we also standarize the way we conduct experiments, in order to allow for a more systematic and organized approach to the development of models.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">LightningExperiment</span></code> class aims to standartize the way we conduct experiments, including: default callacks and loggers, the directory structure for the logs and checkpoints, logging of hyperparameters, and the way we handle the training and evaluation of models and data modules.</p>
<p>In this notebook, we will demonstrate how to use the <code class="docutils literal notranslate"><span class="pre">LightningExperiment</span></code> class to conduct experiments in a systematic and organized way.</p>
Expand Down Expand Up @@ -745,14 +745,6 @@ <h3>CPC performance evaluation experiment<a class="headerlink" href="#CPC-perfor
<div class="output_area docutils container">
<script type="application/vnd.jupyter.widget-view+json">{"model_id": "bc9753a4e8d549daad98bc8a70185c97", "version_major": 2, "version_minor": 0}</script></div>
</div>
<div class="nbinput nblast docutils container">
<div class="prompt highlight-none notranslate"><div class="highlight"><pre><span></span>[ ]:
</pre></div>
</div>
<div class="input_area highlight-ipython3 notranslate"><div class="highlight"><pre><span></span>
</pre></div>
</div>
</div>
</section>
</section>
<section id="Other-advantages-of-using-LightningExperiment">
Expand Down
9 changes: 1 addition & 8 deletions notebooks/04_using_experiments.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Using Experiments\n",
"# 4. Using Experiments\n",
"\n",
"Although the process of training and evaluating models becomes easier due to the abstractions and facilities provided by this framework and Pytorch Lightning, we also standarize the way we conduct experiments, in order to allow for a more systematic and organized approach to the development of models.\n",
"\n",
Expand Down Expand Up @@ -892,13 +892,6 @@
" print(f\"Test on dataset {dataset} finished!\")"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions tutorials.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
<li class="toctree-l2"><a class="reference internal" href="notebooks/01_structuring_input.html">1. Structuring the input</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/02_training_model.html">2. Training a Pytorch Lighning model</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/03_training_ssl_model.html">3. Training a self-supervised model (CPC)</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/04_using_experiments.html">Using Experiments</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/04_using_experiments.html">4. Using Experiments</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="experiments.html">Running Experiments</a></li>
Expand Down Expand Up @@ -107,7 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="notebooks/03_training_ssl_model.html#Next-steps">Next steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="notebooks/04_using_experiments.html">Using Experiments</a><ul>
<li class="toctree-l1"><a class="reference internal" href="notebooks/04_using_experiments.html">4. Using Experiments</a><ul>
<li class="toctree-l2"><a class="reference internal" href="notebooks/04_using_experiments.html#Experiment-Structure">Experiment Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/04_using_experiments.html#Running-CPC-Experiment">Running CPC Experiment</a></li>
<li class="toctree-l2"><a class="reference internal" href="notebooks/04_using_experiments.html#Other-advantages-of-using-LightningExperiment">Other advantages of using <code class="docutils literal notranslate"><span class="pre">LightningExperiment</span></code></a></li>
Expand Down

0 comments on commit 2cc2ffc

Please sign in to comment.