diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d0c3cbf1 --- /dev/null +++ b/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) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..dc1312ab --- /dev/null +++ b/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 diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..bf475592 --- /dev/null +++ b/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'] diff --git a/docs/source/hezar.data.datasets.rst b/docs/source/hezar.data.datasets.rst new file mode 100644 index 00000000..21ffa2b2 --- /dev/null +++ b/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: diff --git a/docs/source/hezar.data.rst b/docs/source/hezar.data.rst new file mode 100644 index 00000000..4ee63ddb --- /dev/null +++ b/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: diff --git a/docs/source/hezar.embeddings.rst b/docs/source/hezar.embeddings.rst new file mode 100644 index 00000000..cd464513 --- /dev/null +++ b/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: diff --git a/docs/source/hezar.metrics.rst b/docs/source/hezar.metrics.rst new file mode 100644 index 00000000..0018768f --- /dev/null +++ b/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: diff --git a/docs/source/hezar.models.audio_classification.rst b/docs/source/hezar.models.audio_classification.rst new file mode 100644 index 00000000..006b158b --- /dev/null +++ b/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: diff --git a/docs/source/hezar.models.image2text.crnn.rst b/docs/source/hezar.models.image2text.crnn.rst new file mode 100644 index 00000000..b7d2466d --- /dev/null +++ b/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: diff --git a/docs/source/hezar.models.image2text.rst b/docs/source/hezar.models.image2text.rst new file mode 100644 index 00000000..eb77cf87 --- /dev/null +++ b/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: diff --git a/docs/source/hezar.models.image2text.trocr.rst b/docs/source/hezar.models.image2text.trocr.rst new file mode 100644 index 00000000..b7ba9a52 --- /dev/null +++ b/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: diff --git a/docs/source/hezar.models.language_modeling.bert.rst b/docs/source/hezar.models.language_modeling.bert.rst new file mode 100644 index 00000000..de62d0c3 --- /dev/null +++ b/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: diff --git a/docs/source/hezar.models.language_modeling.distilbert.rst b/docs/source/hezar.models.language_modeling.distilbert.rst new file mode 100644 index 00000000..2b506e6c --- /dev/null +++ b/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: diff --git a/docs/source/hezar.models.language_modeling.roberta.rst b/docs/source/hezar.models.language_modeling.roberta.rst new file mode 100644 index 00000000..4ebc2a95 --- /dev/null +++ b/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: diff --git a/docs/source/hezar.models.language_modeling.rst b/docs/source/hezar.models.language_modeling.rst new file mode 100644 index 00000000..e03a48c4 --- /dev/null +++ b/docs/source/hezar.models.language_modeling.rst @@ -0,0 +1,20 @@ +hezar.models.language\_modeling package +======================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.models.language_modeling.bert + hezar.models.language_modeling.distilbert + hezar.models.language_modeling.roberta + +Module contents +--------------- + +.. automodule:: hezar.models.language_modeling + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.rst b/docs/source/hezar.models.rst new file mode 100644 index 00000000..c9e8fdfd --- /dev/null +++ b/docs/source/hezar.models.rst @@ -0,0 +1,44 @@ +hezar.models package +==================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.models.audio_classification + hezar.models.image2text + hezar.models.language_modeling + hezar.models.sequence_labeling + hezar.models.speech_recognition + hezar.models.text2text + hezar.models.text_classification + hezar.models.text_detection + +Submodules +---------- + +hezar.models.model module +------------------------- + +.. automodule:: hezar.models.model + :members: + :undoc-members: + :show-inheritance: + +hezar.models.model\_outputs module +---------------------------------- + +.. automodule:: hezar.models.model_outputs + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.sequence_labeling.bert.rst b/docs/source/hezar.models.sequence_labeling.bert.rst new file mode 100644 index 00000000..e6ee69b1 --- /dev/null +++ b/docs/source/hezar.models.sequence_labeling.bert.rst @@ -0,0 +1,29 @@ +hezar.models.sequence\_labeling.bert package +============================================ + +Submodules +---------- + +hezar.models.sequence\_labeling.bert.bert\_sequence\_labeling module +-------------------------------------------------------------------- + +.. automodule:: hezar.models.sequence_labeling.bert.bert_sequence_labeling + :members: + :undoc-members: + :show-inheritance: + +hezar.models.sequence\_labeling.bert.bert\_sequence\_labeling\_config module +---------------------------------------------------------------------------- + +.. automodule:: hezar.models.sequence_labeling.bert.bert_sequence_labeling_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models.sequence_labeling.bert + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.sequence_labeling.distilbert.rst b/docs/source/hezar.models.sequence_labeling.distilbert.rst new file mode 100644 index 00000000..65ccdfeb --- /dev/null +++ b/docs/source/hezar.models.sequence_labeling.distilbert.rst @@ -0,0 +1,29 @@ +hezar.models.sequence\_labeling.distilbert package +================================================== + +Submodules +---------- + +hezar.models.sequence\_labeling.distilbert.distilbert\_sequence\_labeling module +-------------------------------------------------------------------------------- + +.. automodule:: hezar.models.sequence_labeling.distilbert.distilbert_sequence_labeling + :members: + :undoc-members: + :show-inheritance: + +hezar.models.sequence\_labeling.distilbert.distilbert\_sequence\_labeling\_config module +---------------------------------------------------------------------------------------- + +.. automodule:: hezar.models.sequence_labeling.distilbert.distilbert_sequence_labeling_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models.sequence_labeling.distilbert + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.sequence_labeling.roberta.rst b/docs/source/hezar.models.sequence_labeling.roberta.rst new file mode 100644 index 00000000..57ba67e5 --- /dev/null +++ b/docs/source/hezar.models.sequence_labeling.roberta.rst @@ -0,0 +1,29 @@ +hezar.models.sequence\_labeling.roberta package +=============================================== + +Submodules +---------- + +hezar.models.sequence\_labeling.roberta.roberta\_sequence\_labeling module +-------------------------------------------------------------------------- + +.. automodule:: hezar.models.sequence_labeling.roberta.roberta_sequence_labeling + :members: + :undoc-members: + :show-inheritance: + +hezar.models.sequence\_labeling.roberta.roberta\_sequence\_labeling\_config module +---------------------------------------------------------------------------------- + +.. automodule:: hezar.models.sequence_labeling.roberta.roberta_sequence_labeling_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models.sequence_labeling.roberta + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.sequence_labeling.rst b/docs/source/hezar.models.sequence_labeling.rst new file mode 100644 index 00000000..5149a573 --- /dev/null +++ b/docs/source/hezar.models.sequence_labeling.rst @@ -0,0 +1,20 @@ +hezar.models.sequence\_labeling package +======================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.models.sequence_labeling.bert + hezar.models.sequence_labeling.distilbert + hezar.models.sequence_labeling.roberta + +Module contents +--------------- + +.. automodule:: hezar.models.sequence_labeling + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.speech_recognition.rst b/docs/source/hezar.models.speech_recognition.rst new file mode 100644 index 00000000..ad2a64a2 --- /dev/null +++ b/docs/source/hezar.models.speech_recognition.rst @@ -0,0 +1,19 @@ +hezar.models.speech\_recognition package +======================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.models.speech_recognition.wav2vec + hezar.models.speech_recognition.whisper + +Module contents +--------------- + +.. automodule:: hezar.models.speech_recognition + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.speech_recognition.wav2vec.rst b/docs/source/hezar.models.speech_recognition.wav2vec.rst new file mode 100644 index 00000000..981a9eba --- /dev/null +++ b/docs/source/hezar.models.speech_recognition.wav2vec.rst @@ -0,0 +1,10 @@ +hezar.models.speech\_recognition.wav2vec package +================================================ + +Module contents +--------------- + +.. automodule:: hezar.models.speech_recognition.wav2vec + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.speech_recognition.whisper.rst b/docs/source/hezar.models.speech_recognition.whisper.rst new file mode 100644 index 00000000..00eda3fd --- /dev/null +++ b/docs/source/hezar.models.speech_recognition.whisper.rst @@ -0,0 +1,29 @@ +hezar.models.speech\_recognition.whisper package +================================================ + +Submodules +---------- + +hezar.models.speech\_recognition.whisper.whisper\_speech\_recognition module +---------------------------------------------------------------------------- + +.. automodule:: hezar.models.speech_recognition.whisper.whisper_speech_recognition + :members: + :undoc-members: + :show-inheritance: + +hezar.models.speech\_recognition.whisper.whisper\_speech\_recognition\_config module +------------------------------------------------------------------------------------ + +.. automodule:: hezar.models.speech_recognition.whisper.whisper_speech_recognition_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models.speech_recognition.whisper + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text2text.rst b/docs/source/hezar.models.text2text.rst new file mode 100644 index 00000000..26fb0d11 --- /dev/null +++ b/docs/source/hezar.models.text2text.rst @@ -0,0 +1,18 @@ +hezar.models.text2text package +============================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.models.text2text.t5 + +Module contents +--------------- + +.. automodule:: hezar.models.text2text + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text2text.t5.rst b/docs/source/hezar.models.text2text.t5.rst new file mode 100644 index 00000000..7d88ad18 --- /dev/null +++ b/docs/source/hezar.models.text2text.t5.rst @@ -0,0 +1,29 @@ +hezar.models.text2text.t5 package +================================= + +Submodules +---------- + +hezar.models.text2text.t5.t5\_text2text module +---------------------------------------------- + +.. automodule:: hezar.models.text2text.t5.t5_text2text + :members: + :undoc-members: + :show-inheritance: + +hezar.models.text2text.t5.t5\_text2text\_config module +------------------------------------------------------ + +.. automodule:: hezar.models.text2text.t5.t5_text2text_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models.text2text.t5 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text_classification.bert.rst b/docs/source/hezar.models.text_classification.bert.rst new file mode 100644 index 00000000..9736f798 --- /dev/null +++ b/docs/source/hezar.models.text_classification.bert.rst @@ -0,0 +1,29 @@ +hezar.models.text\_classification.bert package +============================================== + +Submodules +---------- + +hezar.models.text\_classification.bert.bert\_text\_classification module +------------------------------------------------------------------------ + +.. automodule:: hezar.models.text_classification.bert.bert_text_classification + :members: + :undoc-members: + :show-inheritance: + +hezar.models.text\_classification.bert.bert\_text\_classification\_config module +-------------------------------------------------------------------------------- + +.. automodule:: hezar.models.text_classification.bert.bert_text_classification_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models.text_classification.bert + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text_classification.distilbert.rst b/docs/source/hezar.models.text_classification.distilbert.rst new file mode 100644 index 00000000..c9a66fb1 --- /dev/null +++ b/docs/source/hezar.models.text_classification.distilbert.rst @@ -0,0 +1,29 @@ +hezar.models.text\_classification.distilbert package +==================================================== + +Submodules +---------- + +hezar.models.text\_classification.distilbert.distilbert\_text\_classification module +------------------------------------------------------------------------------------ + +.. automodule:: hezar.models.text_classification.distilbert.distilbert_text_classification + :members: + :undoc-members: + :show-inheritance: + +hezar.models.text\_classification.distilbert.distilbert\_text\_classification\_config module +-------------------------------------------------------------------------------------------- + +.. automodule:: hezar.models.text_classification.distilbert.distilbert_text_classification_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models.text_classification.distilbert + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text_classification.roberta.rst b/docs/source/hezar.models.text_classification.roberta.rst new file mode 100644 index 00000000..bc5bb51b --- /dev/null +++ b/docs/source/hezar.models.text_classification.roberta.rst @@ -0,0 +1,29 @@ +hezar.models.text\_classification.roberta package +================================================= + +Submodules +---------- + +hezar.models.text\_classification.roberta.roberta\_text\_classification module +------------------------------------------------------------------------------ + +.. automodule:: hezar.models.text_classification.roberta.roberta_text_classification + :members: + :undoc-members: + :show-inheritance: + +hezar.models.text\_classification.roberta.roberta\_text\_classification\_config module +-------------------------------------------------------------------------------------- + +.. automodule:: hezar.models.text_classification.roberta.roberta_text_classification_config + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.models.text_classification.roberta + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text_classification.rst b/docs/source/hezar.models.text_classification.rst new file mode 100644 index 00000000..0c4fc19c --- /dev/null +++ b/docs/source/hezar.models.text_classification.rst @@ -0,0 +1,20 @@ +hezar.models.text\_classification package +========================================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.models.text_classification.bert + hezar.models.text_classification.distilbert + hezar.models.text_classification.roberta + +Module contents +--------------- + +.. automodule:: hezar.models.text_classification + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text_detection.ctpn.rst b/docs/source/hezar.models.text_detection.ctpn.rst new file mode 100644 index 00000000..788d9743 --- /dev/null +++ b/docs/source/hezar.models.text_detection.ctpn.rst @@ -0,0 +1,10 @@ +hezar.models.text\_detection.ctpn package +========================================= + +Module contents +--------------- + +.. automodule:: hezar.models.text_detection.ctpn + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text_detection.dbnet.rst b/docs/source/hezar.models.text_detection.dbnet.rst new file mode 100644 index 00000000..e5acacf1 --- /dev/null +++ b/docs/source/hezar.models.text_detection.dbnet.rst @@ -0,0 +1,10 @@ +hezar.models.text\_detection.dbnet package +========================================== + +Module contents +--------------- + +.. automodule:: hezar.models.text_detection.dbnet + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.models.text_detection.rst b/docs/source/hezar.models.text_detection.rst new file mode 100644 index 00000000..4f08a0e3 --- /dev/null +++ b/docs/source/hezar.models.text_detection.rst @@ -0,0 +1,19 @@ +hezar.models.text\_detection package +==================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.models.text_detection.ctpn + hezar.models.text_detection.dbnet + +Module contents +--------------- + +.. automodule:: hezar.models.text_detection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.preprocessors.feature_extractors.audio.rst b/docs/source/hezar.preprocessors.feature_extractors.audio.rst new file mode 100644 index 00000000..e693a03a --- /dev/null +++ b/docs/source/hezar.preprocessors.feature_extractors.audio.rst @@ -0,0 +1,29 @@ +hezar.preprocessors.feature\_extractors.audio package +===================================================== + +Submodules +---------- + +hezar.preprocessors.feature\_extractors.audio.audio\_feature\_extractor module +------------------------------------------------------------------------------ + +.. automodule:: hezar.preprocessors.feature_extractors.audio.audio_feature_extractor + :members: + :undoc-members: + :show-inheritance: + +hezar.preprocessors.feature\_extractors.audio.whisper\_feature\_extractor module +-------------------------------------------------------------------------------- + +.. automodule:: hezar.preprocessors.feature_extractors.audio.whisper_feature_extractor + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.preprocessors.feature_extractors.audio + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.preprocessors.feature_extractors.rst b/docs/source/hezar.preprocessors.feature_extractors.rst new file mode 100644 index 00000000..de2dbbbc --- /dev/null +++ b/docs/source/hezar.preprocessors.feature_extractors.rst @@ -0,0 +1,18 @@ +hezar.preprocessors.feature\_extractors package +=============================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.preprocessors.feature_extractors.audio + +Module contents +--------------- + +.. automodule:: hezar.preprocessors.feature_extractors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.preprocessors.rst b/docs/source/hezar.preprocessors.rst new file mode 100644 index 00000000..857bb55c --- /dev/null +++ b/docs/source/hezar.preprocessors.rst @@ -0,0 +1,38 @@ +hezar.preprocessors package +=========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.preprocessors.feature_extractors + hezar.preprocessors.tokenizers + +Submodules +---------- + +hezar.preprocessors.preprocessor module +--------------------------------------- + +.. automodule:: hezar.preprocessors.preprocessor + :members: + :undoc-members: + :show-inheritance: + +hezar.preprocessors.text\_normalizer module +------------------------------------------- + +.. automodule:: hezar.preprocessors.text_normalizer + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.preprocessors + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.preprocessors.tokenizers.rst b/docs/source/hezar.preprocessors.tokenizers.rst new file mode 100644 index 00000000..d302f9b4 --- /dev/null +++ b/docs/source/hezar.preprocessors.tokenizers.rst @@ -0,0 +1,61 @@ +hezar.preprocessors.tokenizers package +====================================== + +Submodules +---------- + +hezar.preprocessors.tokenizers.bpe module +----------------------------------------- + +.. automodule:: hezar.preprocessors.tokenizers.bpe + :members: + :undoc-members: + :show-inheritance: + +hezar.preprocessors.tokenizers.sentencepiece\_bpe module +-------------------------------------------------------- + +.. automodule:: hezar.preprocessors.tokenizers.sentencepiece_bpe + :members: + :undoc-members: + :show-inheritance: + +hezar.preprocessors.tokenizers.sentencepiece\_unigram module +------------------------------------------------------------ + +.. automodule:: hezar.preprocessors.tokenizers.sentencepiece_unigram + :members: + :undoc-members: + :show-inheritance: + +hezar.preprocessors.tokenizers.tokenizer module +----------------------------------------------- + +.. automodule:: hezar.preprocessors.tokenizers.tokenizer + :members: + :undoc-members: + :show-inheritance: + +hezar.preprocessors.tokenizers.whisper\_bpe module +-------------------------------------------------- + +.. automodule:: hezar.preprocessors.tokenizers.whisper_bpe + :members: + :undoc-members: + :show-inheritance: + +hezar.preprocessors.tokenizers.wordpiece module +----------------------------------------------- + +.. automodule:: hezar.preprocessors.tokenizers.wordpiece + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.preprocessors.tokenizers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.rst b/docs/source/hezar.rst new file mode 100644 index 00000000..8f6ccde0 --- /dev/null +++ b/docs/source/hezar.rst @@ -0,0 +1,67 @@ +hezar package +============= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.data + hezar.embeddings + hezar.metrics + hezar.models + hezar.preprocessors + hezar.trainers + hezar.utils + +Submodules +---------- + +hezar.builders module +--------------------- + +.. automodule:: hezar.builders + :members: + :undoc-members: + :show-inheritance: + +hezar.configs module +-------------------- + +.. automodule:: hezar.configs + :members: + :undoc-members: + :show-inheritance: + +hezar.constants module +---------------------- + +.. automodule:: hezar.constants + :members: + :undoc-members: + :show-inheritance: + +hezar.integrations module +------------------------- + +.. automodule:: hezar.integrations + :members: + :undoc-members: + :show-inheritance: + +hezar.registry module +--------------------- + +.. automodule:: hezar.registry + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.trainers.rst b/docs/source/hezar.trainers.rst new file mode 100644 index 00000000..a513d58a --- /dev/null +++ b/docs/source/hezar.trainers.rst @@ -0,0 +1,38 @@ +hezar.trainers package +====================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + hezar.trainers.sequence_labeling + hezar.trainers.text_classification + +Submodules +---------- + +hezar.trainers.trainer module +----------------------------- + +.. automodule:: hezar.trainers.trainer + :members: + :undoc-members: + :show-inheritance: + +hezar.trainers.trainer\_utils module +------------------------------------ + +.. automodule:: hezar.trainers.trainer_utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.trainers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.trainers.sequence_labeling.rst b/docs/source/hezar.trainers.sequence_labeling.rst new file mode 100644 index 00000000..e25d2142 --- /dev/null +++ b/docs/source/hezar.trainers.sequence_labeling.rst @@ -0,0 +1,21 @@ +hezar.trainers.sequence\_labeling package +========================================= + +Submodules +---------- + +hezar.trainers.sequence\_labeling.sequence\_labeling\_trainer module +-------------------------------------------------------------------- + +.. automodule:: hezar.trainers.sequence_labeling.sequence_labeling_trainer + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.trainers.sequence_labeling + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.trainers.text_classification.rst b/docs/source/hezar.trainers.text_classification.rst new file mode 100644 index 00000000..96c80604 --- /dev/null +++ b/docs/source/hezar.trainers.text_classification.rst @@ -0,0 +1,21 @@ +hezar.trainers.text\_classification package +=========================================== + +Submodules +---------- + +hezar.trainers.text\_classification.text\_classification\_trainer module +------------------------------------------------------------------------ + +.. automodule:: hezar.trainers.text_classification.text_classification_trainer + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.trainers.text_classification + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/hezar.utils.rst b/docs/source/hezar.utils.rst new file mode 100644 index 00000000..c6b8dd29 --- /dev/null +++ b/docs/source/hezar.utils.rst @@ -0,0 +1,85 @@ +hezar.utils package +=================== + +Submodules +---------- + +hezar.utils.audio\_utils module +------------------------------- + +.. automodule:: hezar.utils.audio_utils + :members: + :undoc-members: + :show-inheritance: + +hezar.utils.common\_utils module +-------------------------------- + +.. automodule:: hezar.utils.common_utils + :members: + :undoc-members: + :show-inheritance: + +hezar.utils.context\_managers module +------------------------------------ + +.. automodule:: hezar.utils.context_managers + :members: + :undoc-members: + :show-inheritance: + +hezar.utils.core\_utils module +------------------------------ + +.. automodule:: hezar.utils.core_utils + :members: + :undoc-members: + :show-inheritance: + +hezar.utils.data\_utils module +------------------------------ + +.. automodule:: hezar.utils.data_utils + :members: + :undoc-members: + :show-inheritance: + +hezar.utils.file\_utils module +------------------------------ + +.. automodule:: hezar.utils.file_utils + :members: + :undoc-members: + :show-inheritance: + +hezar.utils.hub\_utils module +----------------------------- + +.. automodule:: hezar.utils.hub_utils + :members: + :undoc-members: + :show-inheritance: + +hezar.utils.logging module +-------------------------- + +.. automodule:: hezar.utils.logging + :members: + :undoc-members: + :show-inheritance: + +hezar.utils.registry\_utils module +---------------------------------- + +.. automodule:: hezar.utils.registry_utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: hezar.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..00921b1e --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,21 @@ +.. Hezar documentation master file, created by + sphinx-quickstart on Sun Aug 13 20:37:04 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Hezar's documentation! +================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + modules + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..945e205a --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +hezar +===== + +.. toctree:: + :maxdepth: 4 + + hezar