improving documentations

docs/contributing.rst

@@ -15,7 +15,7 @@ To contribute to EasyDeL, follow these steps:
 
 Code of Conduct
 ------
-Please adhere to the Apache Code of Conduct_ in all interactions related to EasyDeL.
+Please adhere to the `Apache Code of Conduct <https://www.apache.org/foundation/policies/conduct.html>`_ in all interactions related to EasyDeL.
 
 Reporting Bugs
 ------
@@ -41,5 +41,3 @@ License
 By contributing to EasyDeL, you agree that your contributions will be licensed under the Apache License, Version 2.0.
 
 Thank you for your interest in contributing to EasyDeL! We appreciate your support.
-
-.. _Conduct https://www.apache.org/foundation/policies/conduct.html

docs/easydelstate.rst → docs/easydelstate.md

@@ -1,4 +1,4 @@
-**EasyDeLState: A Snapshot of Your EasyDeL Model**
+# **EasyDeLState: A Snapshot of Your EasyDeL Model**
 
 The `EasyDeLState` class acts like a comprehensive container that holds all the essential information about your EasyDeL
 model at a given point in time. Think of it as a snapshot of your model. It includes:

docs/index.rst

@@ -99,7 +99,7 @@ Zare Chavoshi, Erfan. "EasyDeL, an open-source library, is specifically designed
 
     install.md
     contributing
-    easydelstate
+    easydelstate.md
 
 
 .. toctree::

docs/install.rst → docs/install.md

@@ -1,58 +1,69 @@
-Installing EasyDeL
-======
-EasyDeL uses FJFormer and JAX as main dependencies in order to run the scripts but there are some things that needs to be installed such as GO-lang to JAX specific platform installations, but you can simply install EasyDeL via pip:
+# Installing EasyDeL
 
-```
+EasyDeL uses FJFormer and JAX as main dependencies in order to run the scripts but there are some things that needs to
+be installed such as GO-lang to JAX specific platform installations, but you can simply install EasyDeL via pip:
+
+```shell
 pip install easydel
 ```
 
-Installing Jax
-------
-JAX uses XLA to compile and run your NumPy programs on GPUs and TPUs. Compilation happens under the hood by default, with library calls getting just-in-time compiled and executed. But JAX also lets you just-in-time compile your own Python functions into XLA-optimized kernels using a one-function API, jit.
+or install from head
 
+```shell
+pip install git+https://github.com/erfanzar/EasyDeL.git -U -q
+```
+
+## Installing Jax
 
+JAX uses XLA to compile and run your NumPy programs on GPUs and TPUs. Compilation happens under the hood by default,
+with library calls getting just-in-time compiled and executed. But JAX also lets you just-in-time compile your own
+Python functions into XLA-optimized kernels using a one-function API, jit.
 you can install other version too but easydel required at least version of 0.4.16
 
-TPU
-------
+### TPU
+
+inorder to install jax on TPU Devices use following command
+
 ```shell
 !pip install jax[tpu] -f https://storage.googleapis.com/jax-releases/libtpu_releases.html -q
 ```
 
-GPU
-------
+### GPU
+
+### CUDA-12
+
+inorder to install jax on cuda 12 use following command
 
-CUDA-12
-------
 ```shell
 pip install --upgrade pip
 # CUDA 12 installation
 # Note: wheels only available on linux.
 pip install --upgrade "jax[cuda12_pip]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
 ```
 
-CUDA-11
-------
+### CUDA-11
+
+inorder to install jax on cuda 11 use following command
+
 ```shell
 pip install --upgrade pip
 # CUDA 11 installation
 # Note: wheels only available on linux.
 pip install --upgrade "jax[cuda11_pip]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
 ```
 
+#### Installing GO
 
-Installing GO
-------
 Note this Library needs golang to run (for some tracking stuff on TPU/GPU/CPU)
-Ubuntu GO installation
-------
+
+#### Ubuntu GO installation
 
 ```shell
 sudo apt-get update && apt-get upgrade -y
 sudo apt-get install golang -y 
 ```
-Manjaro/Arch GO installation
-------
+
+#### Manjaro/Arch GO installation
 
 ```shell
 sudo pacman -Syyuu go