fixing documentation errors

erfanzar · May 28, 2024 · 2c752dd · 2c752dd
1 parent bd45223
commit 2c752dd
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 11 deletions.
diff --git a/docs/EasyAttentionExample.rst → docs/attentionmodule_example.rst b/docs/EasyAttentionExample.rst → docs/attentionmodule_example.rst
@@ -1,7 +1,8 @@
-# AttentionModule
-
-## what is `AttentionModule`
+AttentionModule
+========
 
+what is `AttentionModule`
+--------
 AttentionModule is a EasyDeL module that can perform attention operation with different strategies to help user achieve
 the best possible performance and numerical stability, here are some strategies supported right now.
 
@@ -14,8 +15,8 @@ the best possible performance and numerical stability, here are some strategies
 7. Wise Ring attention via "wise_ring"
 8. sharded Attention with shard map known as "sharded_vanilla"
 
-## Example of Using Flash Attention on TPU
-
+Example of Using Flash Attention on TPU
+--------
 ```python
 import jax
 import flax.linen.attention as flt

diff --git a/docs/CONTRIBUTING.rst → docs/contributing.rst b/docs/CONTRIBUTING.rst → docs/contributing.rst
diff --git a/docs/DataProcessing.rst → docs/data_processing.rst b/docs/DataProcessing.rst → docs/data_processing.rst
diff --git a/docs/EasyStateExample.md → docs/easydelstate.rst b/docs/EasyStateExample.md → docs/easydelstate.rst
diff --git a/docs/FineTuningExample.rst → docs/finetuning_example.rst b/docs/FineTuningExample.rst → docs/finetuning_example.rst
@@ -1,11 +1,11 @@
-## FineTuning Causal Language Model 🥵
-
+FineTuning Causal Language Model 🥵
+=====
 with using EasyDeL FineTuning LLM (CausalLanguageModels) are easy as much as possible with using Jax and Flax
 and having the benefit of `TPUs` for the best speed here's a simple code to use in order to finetune your
 own Model
 
-_Days Has Been Passed and now using easydel in Jax is way more similar to HF/PyTorch Style
-now it's time to finetune our model_.
+Days Has Been Passed and now using easydel in Jax is way more similar to HF/PyTorch Style
+now it's time to finetune our model.
 
 ```python
 import jax.numpy

diff --git a/docs/LoRA-TransferLearningExample.rst → docs/lora_transferlearning_example.rst b/docs/LoRA-TransferLearningExample.rst → docs/lora_transferlearning_example.rst
@@ -1,5 +1,5 @@
-## EasyDeLXRapTure for layer tuning and LoRA
-
+EasyDeLXRapTure for layer tuning and LoRA
+---------
 in case of using LoRA and applying that on the EasyDeL models there are some other things
 that you might need to config on your own but a lot of things being handled by EasyDeL so let just jump into an example
 for LoRA fine-tuning section and use _EasyDeLXRapTure_ in for mistral models with flash attention example

diff --git a/docs/Parameter-Quantization.md → docs/parameterquantization.rst b/docs/Parameter-Quantization.md → docs/parameterquantization.rst