adds missing doc files to git

DIDSR · May 28, 2024 · 88ae103 · 88ae103
1 parent ae835ea
commit 88ae103
Show file tree

Hide file tree

Showing 16 changed files with 3,871 additions and 0 deletions.
diff --git a/docs/build/doctrees/add_dset.doctree b/docs/build/doctrees/add_dset.doctree
diff --git a/docs/build/doctrees/add_model.doctree b/docs/build/doctrees/add_model.doctree
diff --git a/docs/build/doctrees/addnew_link.doctree b/docs/build/doctrees/addnew_link.doctree
diff --git a/docs/build/doctrees/markdownfiles/conferences_commandlines.doctree b/docs/build/doctrees/markdownfiles/conferences_commandlines.doctree
diff --git a/docs/build/html/_modules/domid/algos/zoo_algos.html b/docs/build/html/_modules/domid/algos/zoo_algos.html
diff --git a/docs/build/html/_modules/domid/mk_exp.html b/docs/build/html/_modules/domid/mk_exp.html
diff --git a/docs/build/html/_modules/domid/tests/utils.html b/docs/build/html/_modules/domid/tests/utils.html
@@ -0,0 +1,376 @@
+
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <meta http-equiv="x-ua-compatible" content="ie=edge">
+  <meta name="lang:clipboard.copy" content="Copy to clipboard">
+  <meta name="lang:clipboard.copied" content="Copied to clipboard">
+  <meta name="lang:search.language" content="en">
+  <meta name="lang:search.pipeline.stopwords" content="True">
+  <meta name="lang:search.pipeline.trimmer" content="True">
+  <meta name="lang:search.result.none" content="No matching documents">
+  <meta name="lang:search.result.one" content="1 matching document">
+  <meta name="lang:search.result.other" content="# matching documents">
+  <meta name="lang:search.tokenizer" content="[\s\-]+">
+
+
+    <link href="https://fonts.gstatic.com/" rel="preconnect" crossorigin>
+    <link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&display=fallback" rel="stylesheet">
+
+    <style>
+      body,
+      input {
+        font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif
+      }
+
+      code,
+      kbd,
+      pre {
+        font-family: "Roboto Mono", "Courier New", Courier, monospace
+      }
+    </style>
+
+
+  <link rel="stylesheet" href="../../../_static/stylesheets/application.css"/>
+  <link rel="stylesheet" href="../../../_static/stylesheets/application-palette.css"/>
+  <link rel="stylesheet" href="../../../_static/stylesheets/application-fixes.css"/>
+
+  <link rel="stylesheet" href="../../../_static/fonts/material-icons.css"/>
+
+  <meta name="theme-color" content="#2196f3">
+  <script src="../../../_static/javascripts/modernizr.js"></script>
+
+
+    <link rel="apple-touch-icon" href="../../../_static/images/apple-icon-152x152.png"/>
+
+
+    <title>domid.tests.utils &#8212; domid  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/material.css" />
+    <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
+    <script src="../../../_static/jquery.js"></script>
+    <script src="../../../_static/underscore.js"></script>
+    <script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="../../../_static/doctools.js"></script>
+    <script src="../../../_static/sphinx_highlight.js"></script>
+    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
+    <link rel="author" title="About these documents" href="../../../about.html" />
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" />
+
+    <link rel="apple-touch-icon" href="../../../_static/images/apple-icon-152x152.png"/>
+
+
+
+  </head>
+  <body dir=ltr
+        data-md-color-primary=teal data-md-color-accent=cyan>
+
+  <svg class="md-svg">
+    <defs data-children-count="0">
+
+      <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
+
+    </defs>
+  </svg>
+
+  <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer">
+  <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search">
+  <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
+  <a href="#_modules/domid/tests/utils" tabindex="1" class="md-skip"> Skip to content </a>
+  <header class="md-header" data-md-component="header">
+  <nav class="md-header-nav md-grid">
+    <div class="md-flex navheader">
+      <div class="md-flex__cell md-flex__cell--shrink">
+        <a href="../../../index.html" title="domid  documentation"
+           class="md-header-nav__button md-logo">
+
+            <i class="md-icon">school</i>
+
+        </a>
+      </div>
+      <div class="md-flex__cell md-flex__cell--shrink">
+        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
+      </div>
+      <div class="md-flex__cell md-flex__cell--stretch">
+        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
+          <span class="md-header-nav__topic">DomId</span>
+          <span class="md-header-nav__topic"> domid.tests.utils </span>
+        </div>
+      </div>
+      <div class="md-flex__cell md-flex__cell--shrink">
+        <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
+
+<div class="md-search" data-md-component="search" role="dialog">
+  <label class="md-search__overlay" for="__search"></label>
+  <div class="md-search__inner" role="search">
+    <form class="md-search__form" action="../../../search.html" method="get" name="search">
+      <input type="text" class="md-search__input" name="q" placeholder="Search"
+             autocapitalize="off" autocomplete="off" spellcheck="false"
+             data-md-component="query" data-md-state="active">
+      <label class="md-icon md-search__icon" for="__search"></label>
+      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
+        &#xE5CD;
+      </button>
+    </form>
+    <div class="md-search__output">
+      <div class="md-search__scrollwrap" data-md-scrollfix>
+        <div class="md-search-result" data-md-component="result">
+          <div class="md-search-result__meta">
+            Type to start searching
+          </div>
+          <ol class="md-search-result__list"></ol>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+      </div>
+
+        <div class="md-flex__cell md-flex__cell--shrink">
+          <div class="md-header-nav__source">
+            <a href="https://github.com/agisga/DomId" title="Go to repository" class="md-source" data-md-source="github">
+
+    <div class="md-source__icon">
+      <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width="28" height="28">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
+    </div>
+
+  <div class="md-source__repository">
+    DomId
+  </div>
+</a>
+          </div>
+        </div>
+
+
+    </div>
+  </nav>
+</header>
+
+
+  <div class="md-container">
+
+
+
+  <nav class="md-tabs" data-md-component="tabs">
+    <div class="md-tabs__inner md-grid">
+      <ul class="md-tabs__list">
+
+            <li class="md-tabs__item"><a href="../../../about_link.html" class="md-tabs__link">About</a></li>
+
+            <li class="md-tabs__item"><a href="../../../readme_link.html" class="md-tabs__link">Quick Start</a></li>
+
+            <li class="md-tabs__item"><a href="../../../addnew_link.html" class="md-tabs__link">Custom Datasets and Models</a></li>
+          <li class="md-tabs__item"><a href="../../index.html" class="md-tabs__link">Module code</a></li>
+      </ul>
+    </div>
+  </nav>
+    <main class="md-main">
+      <div class="md-main__inner md-grid" data-md-component="container">
+
+          <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
+            <div class="md-sidebar__scrollwrap">
+              <div class="md-sidebar__inner">
+                <nav class="md-nav md-nav--primary" data-md-level="0">
+  <label class="md-nav__title md-nav__title--site" for="__drawer">
+    <a href="../../../index.html" title="domid documentation" class="md-nav__button md-logo">
+
+        <i class="md-icon">school</i>
+
+    </a>
+    <a href="../../../index.html"
+       title="domid documentation">DomId</a>
+  </label>
+    <div class="md-nav__source">
+      <a href="https://github.com/agisga/DomId" title="Go to repository" class="md-source" data-md-source="github">
+
+    <div class="md-source__icon">
+      <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" width="28" height="28">
+        <use xlink:href="#__github" width="24" height="24"></use>
+      </svg>
+    </div>
+
+  <div class="md-source__repository">
+    DomId
+  </div>
+</a>
+    </div>
+
+
+
+
+  <ul class="md-nav__list">
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">More information about the models</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../about_link.html" class="md-nav__link">About DomId</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">Datasets and Tasks</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../domid.dsets.html" class="md-nav__link">domid.dsets package</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../domid.tasks.html" class="md-nav__link">domid.tasks package</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">Models</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../domid.compos.html" class="md-nav__link">domid.compos package</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../domid.models.html" class="md-nav__link">domid.models package</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">Training a Model</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../domid.algos.html" class="md-nav__link">domid.algos package</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../domid.trainers.html" class="md-nav__link">domid.trainers package</a>
+
+
+    </li>
+    <li class="md-nav__item">
+
+      <span class="md-nav__link caption"><span class="caption-text">Utilities</span></span>
+
+    </li>
+    <li class="md-nav__item">
+
+
+      <a href="../../../domid.utils.html" class="md-nav__link">domid.utils package</a>
+
+
+    </li>
+  </ul>
+
+
+</nav>
+              </div>
+            </div>
+          </div>
+          <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
+            <div class="md-sidebar__scrollwrap">
+              <div class="md-sidebar__inner">
+
+<nav class="md-nav md-nav--secondary">
+  <ul class="md-nav__list" data-md-scrollfix="">
+  </ul>
+</nav>
+              </div>
+            </div>
+          </div>
+
+        <div class="md-content">
+          <article class="md-content__inner md-typeset" role="main">
+
+  <h1 id="modules-domid-tests-utils--page-root">Source code for domid.tests.utils</h1><div class="highlight"><pre>
+<span></span>import os
+import shutil
+
+from domid.compos.exp.exp_main import Exp
+
+
+<div class="viewcode-block" id="experiment_train"><a class="viewcode-back" href="../../../domid.tests.html#domid.tests.utils.experiment_train">[docs]</a>def experiment_train(args, save_path=None):
+
+    exp = Exp(args)
+    # exp.execute()
+    exp.trainer.before_tr()
+    exp.trainer.tr_epoch(0)
+    # exp.trainer.post_tr()
+    if not save_path is None:
+        # This is used to move the saved model weights and all byproducts of the test run into a temporary
+        # directory, so that the actual results directory will not be polluted with the byproduct files of the tests.
+        # This is also used as a mechanism to reuse the same saved weights between different test functions.
+        source_dir = exp.trainer.storage.ex_path
+        dest_dir = save_path
+        for file_name in os.listdir(source_dir):
+            source_file = os.path.join(source_dir, file_name)
+            destination_file = os.path.join(dest_dir, file_name)
+            shutil.move(source_file, destination_file)
+        if not os.listdir(source_dir):
+            os.rmdir(source_dir)
+        else:
+            raise OSError(f"Trying to delete {source_dir}, but it is not empty.")</div>
+</pre></div>
+
+          </article>
+        </div>
+      </div>
+    </main>
+  </div>
+  <footer class="md-footer">
+    <div class="md-footer-nav">
+      <nav class="md-footer-nav__inner md-grid">
+
+
+        </a>
+
+      </nav>
+    </div>
+    <div class="md-footer-meta md-typeset">
+      <div class="md-footer-meta__inner md-grid">
+        <div class="md-footer-copyright">
+          <div class="md-footer-copyright__highlight">
+              &#169; Copyright 2024, FDA/CDRH/OSEL/DIDSR..
+
+          </div>
+            Created using
+            <a href="http://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
+             and
+            <a href="https://github.com/bashtage/sphinx-material/">Material for
+              Sphinx</a>
+        </div>
+      </div>
+    </div>
+  </footer>
+  <script src="../../../_static/javascripts/application.js"></script>
+  <script>app.initialize({version: "1.0.4", url: {base: ".."}})</script>
+  </body>
+</html>