Skip to content

Commit

Permalink
Add missing page
Browse files Browse the repository at this point in the history
  • Loading branch information
Eve-ning committed Dec 27, 2023
1 parent c8e3d88 commit 64eb808
Show file tree
Hide file tree
Showing 17 changed files with 56 additions and 53 deletions.
2 changes: 1 addition & 1 deletion docs/HelpTOC.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"entities":{"pages":{"Overview":{"id":"Overview","title":"Overview","url":"overview.html","level":0,"tabIndex":0},"Getting-Started":{"id":"Getting-Started","title":"Getting Started","url":"getting-started.html","level":0,"tabIndex":1},"e8e19623_38931":{"id":"e8e19623_38931","title":"Tutorials","level":0,"pages":["Retrieve-our-Datasets"],"tabIndex":2},"Retrieve-our-Datasets":{"id":"Retrieve-our-Datasets","title":"Retrieve our Datasets","url":"retrieve-our-datasets.html","level":1,"parentId":"e8e19623_38931","tabIndex":0},"mix-match":{"id":"mix-match","title":"MixMatch","url":"mix-match.html","level":0,"pages":["mix-match-module","custom-k-aug-dataloaders"],"tabIndex":3},"mix-match-module":{"id":"mix-match-module","title":"MixMatch Module","url":"mix-match-module.html","level":1,"parentId":"mix-match","tabIndex":0},"custom-k-aug-dataloaders":{"id":"custom-k-aug-dataloaders","title":"Custom K-Aug Dataloaders","url":"custom-k-aug-dataloaders.html","level":1,"parentId":"mix-match","tabIndex":1},"e8e19623_38936":{"id":"e8e19623_38936","title":"Model Tests","level":0,"pages":["Model-Test-Chestnut-May-Dec"],"tabIndex":4},"Model-Test-Chestnut-May-Dec":{"id":"Model-Test-Chestnut-May-Dec","title":"Model Test Chestnut May-Dec","url":"model-test-chestnut-may-dec.html","level":1,"parentId":"e8e19623_38936","tabIndex":0},"e8e19623_38938":{"id":"e8e19623_38938","title":"API","level":0,"pages":["load.dataset","load.gcs","preprocessing.scale","preprocessing.extract_segments","preprocessing.morphology","preprocessing.glcm_padded","train.frdc_lightning"],"tabIndex":5},"load.dataset":{"id":"load.dataset","title":"load.dataset","url":"load-dataset.html","level":1,"parentId":"e8e19623_38938","tabIndex":0},"load.gcs":{"id":"load.gcs","title":"load.gcs","url":"load-gcs.html","level":1,"parentId":"e8e19623_38938","tabIndex":1},"preprocessing.scale":{"id":"preprocessing.scale","title":"preprocessing.scale","url":"preprocessing-scale.html","level":1,"parentId":"e8e19623_38938","tabIndex":2},"preprocessing.extract_segments":{"id":"preprocessing.extract_segments","title":"preprocessing.extract_segments","url":"preprocessing-extract-segments.html","level":1,"parentId":"e8e19623_38938","tabIndex":3},"preprocessing.morphology":{"id":"preprocessing.morphology","title":"preprocessing.morphology","url":"preprocessing-morphology.html","level":1,"parentId":"e8e19623_38938","tabIndex":4},"preprocessing.glcm_padded":{"id":"preprocessing.glcm_padded","title":"preprocessing.glcm_padded","url":"preprocessing-glcm-padded.html","level":1,"parentId":"e8e19623_38938","tabIndex":5},"train.frdc_lightning":{"id":"train.frdc_lightning","title":"train.frdc_datamodule \u0026 frdc_module","url":"train-frdc-lightning.html","level":1,"parentId":"e8e19623_38938","tabIndex":6}}},"topLevelIds":["Overview","Getting-Started","e8e19623_38931","mix-match","e8e19623_38936","e8e19623_38938"]}
{"entities":{"pages":{"Overview":{"id":"Overview","title":"Overview","url":"overview.html","level":0,"tabIndex":0},"Getting-Started":{"id":"Getting-Started","title":"Getting Started","url":"getting-started.html","level":0,"pages":["Get-Started-with-Dev-Containers"],"tabIndex":1},"Get-Started-with-Dev-Containers":{"id":"Get-Started-with-Dev-Containers","title":"Get Started with Dev Containers","url":"get-started-with-dev-containers.html","level":1,"parentId":"Getting-Started","tabIndex":0},"e8e19623_66291":{"id":"e8e19623_66291","title":"Tutorials","level":0,"pages":["Retrieve-our-Datasets"],"tabIndex":2},"Retrieve-our-Datasets":{"id":"Retrieve-our-Datasets","title":"Retrieve our Datasets","url":"retrieve-our-datasets.html","level":1,"parentId":"e8e19623_66291","tabIndex":0},"mix-match":{"id":"mix-match","title":"MixMatch","url":"mix-match.html","level":0,"pages":["mix-match-module","custom-k-aug-dataloaders"],"tabIndex":3},"mix-match-module":{"id":"mix-match-module","title":"MixMatch Module","url":"mix-match-module.html","level":1,"parentId":"mix-match","tabIndex":0},"custom-k-aug-dataloaders":{"id":"custom-k-aug-dataloaders","title":"Custom K-Aug Dataloaders","url":"custom-k-aug-dataloaders.html","level":1,"parentId":"mix-match","tabIndex":1},"e8e19623_66296":{"id":"e8e19623_66296","title":"Model Tests","level":0,"pages":["Model-Test-Chestnut-May-Dec"],"tabIndex":4},"Model-Test-Chestnut-May-Dec":{"id":"Model-Test-Chestnut-May-Dec","title":"Model Test Chestnut May-Dec","url":"model-test-chestnut-may-dec.html","level":1,"parentId":"e8e19623_66296","tabIndex":0},"e8e19623_66298":{"id":"e8e19623_66298","title":"API","level":0,"pages":["load.dataset","load.gcs","preprocessing.scale","preprocessing.extract_segments","preprocessing.morphology","preprocessing.glcm_padded","train.frdc_lightning"],"tabIndex":5},"load.dataset":{"id":"load.dataset","title":"load.dataset","url":"load-dataset.html","level":1,"parentId":"e8e19623_66298","tabIndex":0},"load.gcs":{"id":"load.gcs","title":"load.gcs","url":"load-gcs.html","level":1,"parentId":"e8e19623_66298","tabIndex":1},"preprocessing.scale":{"id":"preprocessing.scale","title":"preprocessing.scale","url":"preprocessing-scale.html","level":1,"parentId":"e8e19623_66298","tabIndex":2},"preprocessing.extract_segments":{"id":"preprocessing.extract_segments","title":"preprocessing.extract_segments","url":"preprocessing-extract-segments.html","level":1,"parentId":"e8e19623_66298","tabIndex":3},"preprocessing.morphology":{"id":"preprocessing.morphology","title":"preprocessing.morphology","url":"preprocessing-morphology.html","level":1,"parentId":"e8e19623_66298","tabIndex":4},"preprocessing.glcm_padded":{"id":"preprocessing.glcm_padded","title":"preprocessing.glcm_padded","url":"preprocessing-glcm-padded.html","level":1,"parentId":"e8e19623_66298","tabIndex":5},"train.frdc_lightning":{"id":"train.frdc_lightning","title":"train.frdc_datamodule \u0026 frdc_module","url":"train-frdc-lightning.html","level":1,"parentId":"e8e19623_66298","tabIndex":6}}},"topLevelIds":["Overview","Getting-Started","e8e19623_66291","mix-match","e8e19623_66296","e8e19623_66298"]}
2 changes: 1 addition & 1 deletion docs/Map.jhm
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<?xml version='1.0' encoding='UTF-8'?><map version="2.0"><mapID target="Overview.md" url="overview.html" default="yes"/><mapID target="Overview" url="overview.html" default="yes"/><mapID target="Getting-Started.md" url="getting-started.html" default="no"/><mapID target="Getting-Started" url="getting-started.html" default="no"/><mapID target="Retrieve-our-Datasets.md" url="retrieve-our-datasets.html" default="no"/><mapID target="Retrieve-our-Datasets" url="retrieve-our-datasets.html" default="no"/><mapID target="mix-match.md" url="mix-match.html" default="no"/><mapID target="mix-match" url="mix-match.html" default="no"/><mapID target="mix-match-module.md" url="mix-match-module.html" default="no"/><mapID target="mix-match-module" url="mix-match-module.html" default="no"/><mapID target="custom-k-aug-dataloaders.md" url="custom-k-aug-dataloaders.html" default="no"/><mapID target="custom-k-aug-dataloaders" url="custom-k-aug-dataloaders.html" default="no"/><mapID target="Model-Test-Chestnut-May-Dec.md" url="model-test-chestnut-may-dec.html" default="no"/><mapID target="Model-Test-Chestnut-May-Dec" url="model-test-chestnut-may-dec.html" default="no"/><mapID target="load.dataset.md" url="load-dataset.html" default="no"/><mapID target="load.dataset" url="load-dataset.html" default="no"/><mapID target="load.gcs.md" url="load-gcs.html" default="no"/><mapID target="load.gcs" url="load-gcs.html" default="no"/><mapID target="preprocessing.scale.md" url="preprocessing-scale.html" default="no"/><mapID target="preprocessing.scale" url="preprocessing-scale.html" default="no"/><mapID target="preprocessing.extract_segments.md" url="preprocessing-extract-segments.html" default="no"/><mapID target="preprocessing.extract_segments" url="preprocessing-extract-segments.html" default="no"/><mapID target="preprocessing.morphology.md" url="preprocessing-morphology.html" default="no"/><mapID target="preprocessing.morphology" url="preprocessing-morphology.html" default="no"/><mapID target="preprocessing.glcm_padded.md" url="preprocessing-glcm-padded.html" default="no"/><mapID target="preprocessing.glcm_padded" url="preprocessing-glcm-padded.html" default="no"/><mapID target="train.frdc_lightning.md" url="train-frdc-lightning.html" default="no"/><mapID target="train.frdc_lightning" url="train-frdc-lightning.html" default="no"/></map>
<?xml version='1.0' encoding='UTF-8'?><map version="2.0"><mapID target="Overview.md" url="overview.html" default="yes"/><mapID target="Overview" url="overview.html" default="yes"/><mapID target="Getting-Started.md" url="getting-started.html" default="no"/><mapID target="Getting-Started" url="getting-started.html" default="no"/><mapID target="Get-Started-with-Dev-Containers.md" url="get-started-with-dev-containers.html" default="no"/><mapID target="Get-Started-with-Dev-Containers" url="get-started-with-dev-containers.html" default="no"/><mapID target="Retrieve-our-Datasets.md" url="retrieve-our-datasets.html" default="no"/><mapID target="Retrieve-our-Datasets" url="retrieve-our-datasets.html" default="no"/><mapID target="mix-match.md" url="mix-match.html" default="no"/><mapID target="mix-match" url="mix-match.html" default="no"/><mapID target="mix-match-module.md" url="mix-match-module.html" default="no"/><mapID target="mix-match-module" url="mix-match-module.html" default="no"/><mapID target="custom-k-aug-dataloaders.md" url="custom-k-aug-dataloaders.html" default="no"/><mapID target="custom-k-aug-dataloaders" url="custom-k-aug-dataloaders.html" default="no"/><mapID target="Model-Test-Chestnut-May-Dec.md" url="model-test-chestnut-may-dec.html" default="no"/><mapID target="Model-Test-Chestnut-May-Dec" url="model-test-chestnut-may-dec.html" default="no"/><mapID target="load.dataset.md" url="load-dataset.html" default="no"/><mapID target="load.dataset" url="load-dataset.html" default="no"/><mapID target="load.gcs.md" url="load-gcs.html" default="no"/><mapID target="load.gcs" url="load-gcs.html" default="no"/><mapID target="preprocessing.scale.md" url="preprocessing-scale.html" default="no"/><mapID target="preprocessing.scale" url="preprocessing-scale.html" default="no"/><mapID target="preprocessing.extract_segments.md" url="preprocessing-extract-segments.html" default="no"/><mapID target="preprocessing.extract_segments" url="preprocessing-extract-segments.html" default="no"/><mapID target="preprocessing.morphology.md" url="preprocessing-morphology.html" default="no"/><mapID target="preprocessing.morphology" url="preprocessing-morphology.html" default="no"/><mapID target="preprocessing.glcm_padded.md" url="preprocessing-glcm-padded.html" default="no"/><mapID target="preprocessing.glcm_padded" url="preprocessing-glcm-padded.html" default="no"/><mapID target="train.frdc_lightning.md" url="train-frdc-lightning.html" default="no"/><mapID target="train.frdc_lightning" url="train-frdc-lightning.html" default="no"/></map>
6 changes: 3 additions & 3 deletions docs/custom-k-aug-dataloaders.html

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/get-started-with-dev-containers.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-12-27T17:28:00.263479"> <title>Get Started with Dev Containers | Documentation</title><script type="application/json" id="virtual-toc-data">[{"id":"python-environment","level":0,"title":"Python Environment","anchor":"#python-environment"},{"id":"mark-as-sources-root-add-to-pythonpath","level":0,"title":"Mark as Sources Root (Add to PYTHONPATH)","anchor":"#mark-as-sources-root-add-to-pythonpath"},{"id":"additional-setup","level":0,"title":"Additional Setup","anchor":"#additional-setup"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"> <link rel="manifest" href="site.webmanifest"> <meta name="msapplication-TileColor" content="#000000"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Get Started with Dev Containers | Documentation"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Documentation Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="/d/0.0.8/get-started-with-dev-containers.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Get Started with Dev Containers | Documentation"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{ "@context": "http://schema.org", "@type": "WebPage", "@id": "/d/0.0.8/get-started-with-dev-containers.html#webpage", "url": "/d/0.0.8/get-started-with-dev-containers.html", "name": "Get Started with Dev Containers | Documentation", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{ "@type": "WebSite", "@id": "/d/#website", "url": "/d/", "name": "Documentation Help" }</script><!-- End Schema.org --></head> <body data-id="Get-Started-with-Dev-Containers" data-main-title="Get Started with Dev Containers" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="Getting-Started.md|Getting Started" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Documentation 0.0.8 Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Get-Started-with-Dev-Containers" id="Get-Started-with-Dev-Containers.md">Get Started with Dev Containers</h1> <p id="9f743d83_2249">Dev. Containers are a great way to get started with a project. They define all necessary dependencies and environments, so you can just start coding within the container.</p><p id="9f743d83_2250">In this article, we'll only go over <span class="control" id="9f743d83_2251">additional steps</span> to set up with our project. For more information on how to use Dev Containers, please refer to the official documentation for each IDE. Once you've set up the Dev Container, come back here to finish the setup:</p><ul class="list _ul" id="9f743d83_2252"><li class="list__item" id="9f743d83_2253"><p><a href="https://code.visualstudio.com/docs/remote/containers" id="9f743d83_2254" data-external="true" rel="noopener noreferrer">VSCode</a>.</p></li><li class="list__item" id="9f743d83_2255"><p><a href="https://www.jetbrains.com/help/idea/connect-to-devcontainer.html" id="9f743d83_2256" data-external="true" rel="noopener noreferrer">IntelliJ</a></p></li></ul><aside class="prompt" data-type="warning" data-title="" id="9f743d83_2257"><p id="9f743d83_2258">If you see the error <code class="code" id="9f743d83_2259">Error response from daemon: ... &lt;!DOCTYPE</code>, you forgot the <code class="code" id="9f743d83_2260">.git</code> at the end of the repo URL.</p></aside><section class="chapter"><h2 id="python-environment" data-toc="python-environment">Python Environment</h2><aside class="prompt" data-type="warning" data-title="" id="9f743d83_2261"><p id="9f743d83_2262">Do not create a new environment</p></aside><p id="9f743d83_2263">The dev environment is already created and is managed by Anaconda <code class="code" id="9f743d83_2264">/opt/conda/bin/conda</code>. To activate the environment, run the following command:</p><div class="code-block" data-lang="bash">
conda activate base
</div><aside class="prompt" data-type="tip" data-title="" id="9f743d83_2266"><p id="9f743d83_2267">Refer to your respective IDE's documentation on how to activate the environment.</p></aside></section><section class="chapter"><h2 id="mark-as-sources-root-add-to-pythonpath" data-toc="mark-as-sources-root-add-to-pythonpath">Mark as Sources Root (Add to PYTHONPATH)</h2><p id="9f743d83_2268">For <code class="code" id="9f743d83_2269">import</code> statements to work, you need to mark the <code class="code" id="9f743d83_2270">src</code> folder as the sources root. Optionally, also mark the <code class="code" id="9f743d83_2271">tests</code> folder as the tests root.</p><aside class="prompt" data-type="tip" data-title="" id="9f743d83_2272"><p id="9f743d83_2273">Refer to your respective IDE's documentation on how to mark folders as sources root. (Also known as adding to the <code class="code" id="9f743d83_2274">PYTHONPATH</code>)</p></aside></section><section class="chapter"><h2 id="additional-setup" data-toc="additional-setup">Additional Setup</h2><p id="9f743d83_2275">Refer to the <a href="getting-started.html" id="9f743d83_2276" data-tooltip="Want to use a Dev Container? See Get Started with Dev Containers">Getting Started</a> guide for additional setup steps such as:</p><ul class="list _ul" id="9f743d83_2277"><li class="list__item" id="9f743d83_2278"><p>Google Cloud Application Default Credentials</p></li><li class="list__item" id="9f743d83_2279"><p>Weight &amp; Bias API Key</p></li><li class="list__item" id="9f743d83_2280"><p>Label Studio API Key</p></li></ul></section><div class="last-modified">Last modified: 27 December 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a href="getting-started.html" class="navigation-links__prev">Getting Started</a><a href="retrieve-our-datasets.html" class="navigation-links__next">Retrieve our Datasets</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.6.6-b205/app.js"></script></body></html>
Loading

0 comments on commit 64eb808

Please sign in to comment.