Docs sphinx

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,39 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Hezar'
+copyright = '2023, Hezar AI'
+author = 'Hezar AI'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx_copybutton",
+    "sphinx_inline_tabs",
+    "sphinx_removed_in",
+    "sphinxext.opengraph",
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['_static']

docs/source/hezar.data.datasets.rst

@@ -0,0 +1,45 @@
+hezar.data.datasets package
+===========================
+
+Submodules
+----------
+
+hezar.data.datasets.dataset module
+----------------------------------
+
+.. automodule:: hezar.data.datasets.dataset
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.data.datasets.sequence\_labeling\_dataset module
+------------------------------------------------------
+
+.. automodule:: hezar.data.datasets.sequence_labeling_dataset
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.data.datasets.text\_classification\_dataset module
+--------------------------------------------------------
+
+.. automodule:: hezar.data.datasets.text_classification_dataset
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.data.datasets.text\_summarization\_dataset module
+-------------------------------------------------------
+
+.. automodule:: hezar.data.datasets.text_summarization_dataset
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: hezar.data.datasets
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.data.rst

@@ -0,0 +1,29 @@
+hezar.data package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   hezar.data.datasets
+
+Submodules
+----------
+
+hezar.data.data\_collators module
+---------------------------------
+
+.. automodule:: hezar.data.data_collators
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: hezar.data
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.embeddings.rst

@@ -0,0 +1,37 @@
+hezar.embeddings package
+========================
+
+Submodules
+----------
+
+hezar.embeddings.embedding module
+---------------------------------
+
+.. automodule:: hezar.embeddings.embedding
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.embeddings.fasttext module
+--------------------------------
+
+.. automodule:: hezar.embeddings.fasttext
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.embeddings.word2vec module
+--------------------------------
+
+.. automodule:: hezar.embeddings.word2vec
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: hezar.embeddings
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.metrics.rst

@@ -0,0 +1,45 @@
+hezar.metrics package
+=====================
+
+Submodules
+----------
+
+hezar.metrics.f1 module
+-----------------------
+
+.. automodule:: hezar.metrics.f1
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.metrics.metric module
+---------------------------
+
+.. automodule:: hezar.metrics.metric
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.metrics.recall module
+---------------------------
+
+.. automodule:: hezar.metrics.recall
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.metrics.seqeval module
+----------------------------
+
+.. automodule:: hezar.metrics.seqeval
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: hezar.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.models.audio_classification.rst

@@ -0,0 +1,10 @@
+hezar.models.audio\_classification package
+==========================================
+
+Module contents
+---------------
+
+.. automodule:: hezar.models.audio_classification
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.models.image2text.crnn.rst

@@ -0,0 +1,10 @@
+hezar.models.image2text.crnn package
+====================================
+
+Module contents
+---------------
+
+.. automodule:: hezar.models.image2text.crnn
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.models.image2text.rst

@@ -0,0 +1,19 @@
+hezar.models.image2text package
+===============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   hezar.models.image2text.crnn
+   hezar.models.image2text.trocr
+
+Module contents
+---------------
+
+.. automodule:: hezar.models.image2text
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.models.image2text.trocr.rst

@@ -0,0 +1,10 @@
+hezar.models.image2text.trocr package
+=====================================
+
+Module contents
+---------------
+
+.. automodule:: hezar.models.image2text.trocr
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.models.language_modeling.bert.rst

@@ -0,0 +1,29 @@
+hezar.models.language\_modeling.bert package
+============================================
+
+Submodules
+----------
+
+hezar.models.language\_modeling.bert.bert\_lm module
+----------------------------------------------------
+
+.. automodule:: hezar.models.language_modeling.bert.bert_lm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.models.language\_modeling.bert.bert\_lm\_config module
+------------------------------------------------------------
+
+.. automodule:: hezar.models.language_modeling.bert.bert_lm_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: hezar.models.language_modeling.bert
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.models.language_modeling.distilbert.rst

@@ -0,0 +1,29 @@
+hezar.models.language\_modeling.distilbert package
+==================================================
+
+Submodules
+----------
+
+hezar.models.language\_modeling.distilbert.distilbert\_lm module
+----------------------------------------------------------------
+
+.. automodule:: hezar.models.language_modeling.distilbert.distilbert_lm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.models.language\_modeling.distilbert.distilbert\_lm\_config module
+------------------------------------------------------------------------
+
+.. automodule:: hezar.models.language_modeling.distilbert.distilbert_lm_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: hezar.models.language_modeling.distilbert
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/hezar.models.language_modeling.roberta.rst

@@ -0,0 +1,29 @@
+hezar.models.language\_modeling.roberta package
+===============================================
+
+Submodules
+----------
+
+hezar.models.language\_modeling.roberta.roberta\_lm module
+----------------------------------------------------------
+
+.. automodule:: hezar.models.language_modeling.roberta.roberta_lm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hezar.models.language\_modeling.roberta.roberta\_lm\_config module
+------------------------------------------------------------------
+
+.. automodule:: hezar.models.language_modeling.roberta.roberta_lm_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: hezar.models.language_modeling.roberta
+   :members:
+   :undoc-members:
+   :show-inheritance: