improving documentations

erfanzar · May 28, 2024 · 9063706 · 9063706
1 parent 143bb3a
commit 9063706
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ of machine learning models, particularly in the domain of large language models
 ## Documentation 💫
 
 > [!IMPORTANT]
-> Documents and Examples are ready at [Here](https://erfanzar.github.io/EasyDeL)
+> Documents and Examples are ready at [Here](https://easydel.readthedocs.io/en/latest/)
 > Please have that in mind that EasyDeL is in the loop of fast-development
 > so we might have API changes.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -13,6 +13,7 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
     "sphinx_autodoc_typehints",
+    "myst_parser"
 ]
 
 templates_path = ["_templates"]

diff --git a/docs/index.rst b/docs/index.rst
@@ -88,39 +88,47 @@ Citing EasyDeL 🥶
 To cite this Project
 ---------------------------------------------------------------
 
-```misc
-@misc{Zare Chavoshi_2023,
-    title={EasyDeL, an open-source library, is specifically designed to enhance and streamline the training process of machine learning models. It focuses primarily on Jax/Flax and aims to provide convenient and effective solutions for training Flax/Jax Models on TPU/GPU for both Serving and Training purposes.},
-    url={https://github.com/erfanzar/EasyDeL},
-    journal={EasyDeL Easy and Fast DeepLearning with JAX},
-    publisher={Erfan Zare Chavoshi},
-    author={Zare Chavoshi, Erfan},
-    year={2023}
-} 
-```
+.. _EasyDeL:
+
+Zare Chavoshi, Erfan. "EasyDeL, an open-source library, is specifically designed to enhance and streamline the training process of machine learning models. It focuses primarily on Jax/Flax and aims to provide convenient and effective solutions for training Flax/Jax Models on TPU/GPU for both Serving and Training purposes." 2023. https://github.com/erfanzar/EasyDeL
 
 .. toctree::
     :hidden:
     :maxdepth: 1
     :caption: Getting Started
 
-    install
+    install.md
     contributing
+
 .. toctree::
     :hidden:
     :maxdepth: 1
     :caption: EasyDeL Magics
 
-    easydelstate
+    easydelstate.md
 
 .. toctree::
     :hidden:
     :maxdepth: 1
     :caption: Examples
 
-    finetuning_example
-    lora_transferlearning_example
-    parameterquantization
-    attentionmodule_example
-    data_processing
+    finetuning_example.md
+    lora_transferlearning_example.md
+    parameterquantization.md
+    attentionmodule_example.md
+    data_processing.md
+
+
+.. bibliography:: references.bib
+   :filter: author % "Zare Chavoshi"
+
+   .. code-block:: bibtex
 
+      @misc{Zare Chavoshi_2023,
+          title={EasyDeL, an open-source library, is specifically designed to enhance and streamline the training process of machine learning models. It focuses primarily on Jax/Flax and aims to provide convenient and effective solutions for training Flax/Jax Models on TPU/GPU for both Serving and Training purposes.},
+          url={https://github.com/erfanzar/EasyDeL},
+          journal={EasyDeL Easy and Fast DeepLearning with JAX},
+          publisher={Erfan Zare Chavoshi},
+          author={Zare Chavoshi, Erfan},
+          year={2023}
+      }
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -24,4 +24,5 @@ accelerate
 sphinx
 sphinx-autobuild
 sphinx-autodoc-typehints
-sphinx-book-theme
+sphinx-book-theme
+myst-parser