-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit cda9670
Showing
54 changed files
with
5,511 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Sphinx build info version 1 | ||
| # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
| config: 5fac6a6ea6328a931e5851f2ec63adf9 | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,244 @@ | ||
| <!doctype html> | ||
| <html class="no-js" lang="en" data-content_root="./"> | ||
| <head><meta charset="utf-8"/> | ||
| <meta name="viewport" content="width=device-width,initial-scale=1"/> | ||
| <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /> | ||
|
|
||
| <!-- Generated with Sphinx 7.2.2 and Furo 2023.08.19 --> | ||
| <title>Hezar Technical Documentation - Hezar documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" /> | ||
| <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" /> | ||
| <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" /> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <style> | ||
| body { | ||
| --color-code-background: #f8f8f8; | ||
| --color-code-foreground: black; | ||
|
|
||
| } | ||
| @media not print { | ||
| body[data-theme="dark"] { | ||
| --color-code-background: #202020; | ||
| --color-code-foreground: #d0d0d0; | ||
|
|
||
| } | ||
| @media (prefers-color-scheme: dark) { | ||
| body:not([data-theme="light"]) { | ||
| --color-code-background: #202020; | ||
| --color-code-foreground: #d0d0d0; | ||
|
|
||
| } | ||
| } | ||
| } | ||
| </style></head> | ||
| <body> | ||
|
|
||
| <script> | ||
| document.body.dataset.theme = localStorage.getItem("theme") || "auto"; | ||
| </script> | ||
|
|
||
|
|
||
| <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> | ||
| <symbol id="svg-toc" viewBox="0 0 24 24"> | ||
| <title>Contents</title> | ||
| <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> | ||
| <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> | ||
| </svg> | ||
| </symbol> | ||
| <symbol id="svg-menu" viewBox="0 0 24 24"> | ||
| <title>Menu</title> | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" | ||
| stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> | ||
| <line x1="3" y1="12" x2="21" y2="12"></line> | ||
| <line x1="3" y1="6" x2="21" y2="6"></line> | ||
| <line x1="3" y1="18" x2="21" y2="18"></line> | ||
| </svg> | ||
| </symbol> | ||
| <symbol id="svg-arrow-right" viewBox="0 0 24 24"> | ||
| <title>Expand</title> | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" | ||
| stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> | ||
| <polyline points="9 18 15 12 9 6"></polyline> | ||
| </svg> | ||
| </symbol> | ||
| <symbol id="svg-sun" viewBox="0 0 24 24"> | ||
| <title>Light mode</title> | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" | ||
| stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> | ||
| <circle cx="12" cy="12" r="5"></circle> | ||
| <line x1="12" y1="1" x2="12" y2="3"></line> | ||
| <line x1="12" y1="21" x2="12" y2="23"></line> | ||
| <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> | ||
| <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> | ||
| <line x1="1" y1="12" x2="3" y2="12"></line> | ||
| <line x1="21" y1="12" x2="23" y2="12"></line> | ||
| <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> | ||
| <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> | ||
| </svg> | ||
| </symbol> | ||
| <symbol id="svg-moon" viewBox="0 0 24 24"> | ||
| <title>Dark mode</title> | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" | ||
| stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> | ||
| <path stroke="none" d="M0 0h24v24H0z" fill="none" /> | ||
| <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> | ||
| </svg> | ||
| </symbol> | ||
| <symbol id="svg-sun-half" viewBox="0 0 24 24"> | ||
| <title>Auto light/dark mode</title> | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" | ||
| stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> | ||
| <path stroke="none" d="M0 0h24v24H0z" fill="none"/> | ||
| <circle cx="12" cy="12" r="9" /> | ||
| <path d="M13 12h5" /> | ||
| <path d="M13 15h4" /> | ||
| <path d="M13 18h1" /> | ||
| <path d="M13 9h4" /> | ||
| <path d="M13 6h1" /> | ||
| </svg> | ||
| </symbol> | ||
| </svg> | ||
|
|
||
| <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> | ||
| <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> | ||
| <label class="overlay sidebar-overlay" for="__navigation"> | ||
| <div class="visually-hidden">Hide navigation sidebar</div> | ||
| </label> | ||
| <label class="overlay toc-overlay" for="__toc"> | ||
| <div class="visually-hidden">Hide table of contents sidebar</div> | ||
| </label> | ||
|
|
||
|
|
||
|
|
||
| <div class="page"> | ||
| <header class="mobile-header"> | ||
| <div class="header-left"> | ||
| <label class="nav-overlay-icon" for="__navigation"> | ||
| <div class="visually-hidden">Toggle site navigation sidebar</div> | ||
| <i class="icon"><svg><use href="#svg-menu"></use></svg></i> | ||
| </label> | ||
| </div> | ||
| <div class="header-center"> | ||
| <a href="index.html"><div class="brand">Hezar documentation</div></a> | ||
| </div> | ||
| <div class="header-right"> | ||
| <div class="theme-toggle-container theme-toggle-header"> | ||
| <button class="theme-toggle"> | ||
| <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> | ||
| <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> | ||
| <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> | ||
| <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> | ||
| </button> | ||
| </div> | ||
| <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc"> | ||
| <div class="visually-hidden">Toggle table of contents sidebar</div> | ||
| <i class="icon"><svg><use href="#svg-toc"></use></svg></i> | ||
| </label> | ||
| </div> | ||
| </header> | ||
| <aside class="sidebar-drawer"> | ||
| <div class="sidebar-container"> | ||
|
|
||
| <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html"> | ||
|
|
||
|
|
||
| <span class="sidebar-brand-text">Hezar documentation</span> | ||
|
|
||
| </a><form class="sidebar-search-container" method="get" action="search.html" role="search"> | ||
| <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> | ||
| <input type="hidden" name="check_keywords" value="yes"> | ||
| <input type="hidden" name="area" value="default"> | ||
| </form> | ||
| <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> | ||
| <ul> | ||
| <li class="toctree-l1 has-children"><a class="reference internal" href="tutorial/index.html">Tutorial</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Tutorial</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="tutorial/overview.html">Overview</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="tutorial/installation.html">Installation</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="tutorial/models.html">Models</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="tutorial/datasets.html">Datasets</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="tutorial/training.html">Training models</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="tutorial/preprocessors.html">Preprocessors</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </aside> | ||
| <div class="main"> | ||
| <div class="content"> | ||
| <div class="article-container"> | ||
| <a href="#" class="back-to-top muted-link"> | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> | ||
| <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> | ||
| </svg> | ||
| <span>Back to top</span> | ||
| </a> | ||
| <div class="content-icon-container"> | ||
|
|
||
| <div class="theme-toggle-container theme-toggle-content"> | ||
| <button class="theme-toggle"> | ||
| <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> | ||
| <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> | ||
| <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> | ||
| <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> | ||
| </button> | ||
| </div> | ||
| <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc"> | ||
| <div class="visually-hidden">Toggle table of contents sidebar</div> | ||
| <i class="icon"><svg><use href="#svg-toc"></use></svg></i> | ||
| </label> | ||
| </div> | ||
| <article role="main"> | ||
| <section class="tex2jax_ignore mathjax_ignore" id="hezar-technical-documentation"> | ||
| <h1>Hezar Technical Documentation<a class="headerlink" href="#hezar-technical-documentation" title="Link to this heading">#</a></h1> | ||
| <p>This folder is responsible for everything generated or manually authored in the docs. | ||
| The docs are built using <code class="docutils literal notranslate"><span class="pre">Sphinx</span></code> and <code class="docutils literal notranslate"><span class="pre">Furo</span></code>.</p> | ||
| <p>The docs are hosted on <a class="reference external" href="https://hezarai.github.io/hezar/">https://hezarai.github.io/hezar/</a></p> | ||
| </section> | ||
|
|
||
| </article> | ||
| </div> | ||
| <footer> | ||
|
|
||
| <div class="related-pages"> | ||
|
|
||
|
|
||
| </div> | ||
| <div class="bottom-of-page"> | ||
| <div class="left-details"> | ||
| <div class="copyright"> | ||
| Copyright © 2023, Hezar AI Team & contributors | ||
| </div> | ||
| Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s | ||
|
|
||
| <a href="https://github.com/pradyunsg/furo">Furo</a> | ||
|
|
||
| </div> | ||
| <div class="right-details"> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| </footer> | ||
| </div> | ||
| <aside class="toc-drawer no-toc"> | ||
|
|
||
|
|
||
|
|
||
| </aside> | ||
| </div> | ||
| </div><script src="_static/documentation_options.js?v=5929fcd5"></script> | ||
| <script src="_static/doctools.js?v=888ff710"></script> | ||
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> | ||
| <script src="_static/scripts/furo.js?v=32e29ea5"></script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Hezar Technical Documentation | ||
| This folder is responsible for everything generated or manually authored in the docs. | ||
| The docs are built using `Sphinx` and `Furo`. | ||
|
|
||
| The docs are hosted on [https://hezarai.github.io/hezar/](https://hezarai.github.io/hezar/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Welcome to Hezar's documentation! | ||
|
|
||
| ```{toctree} | ||
| :maxdepth: 2 | ||
|
|
||
| tutorial/index.md | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Datasets |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Tutorial | ||
| ```{toctree} | ||
| :maxdepth: 2 | ||
|
|
||
| overview.md | ||
| installation.md | ||
| models.md | ||
| datasets.md | ||
| training.md | ||
| preprocessors.md | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Installation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Models |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Overview | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Preprocessors |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Training models |
Oops, something went wrong.