Add docs/models_in_depth_overview.md

hezarai · Aug 23, 2023 · 23a80d7 · 23a80d7
1 parent 6a0353e
commit 23a80d7
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/docs/guide/hezar_architecture.md b/docs/guide/hezar_architecture.md
@@ -94,10 +94,9 @@ word2vec = Embedding.load("hezarai/word2vec-skipgram-fa-wikipedia")  # A Word2Ve
 ...
 ```
 
-
-**Registry System**<br>
 So, what's going on under the hood that handles module loading and initiation?
 
+**Registry System**<br>
 Well, there are ways to tackle this challenge, but Hezar manages this by using _a global registry_ for every module
 type. These registries are simple Python dictionaries that hold the properties for every module class, module config, 
 etc. 

diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -6,5 +6,6 @@ Welcome to the developer guide section where you can take a deeper dive into the
 :maxdepth: 2
 
 hezar_architecture.md
+models_in_depth_overview.md
 train_custom_models.md
 ```
diff --git a/docs/guide/models_in_depth_overview.md b/docs/guide/models_in_depth_overview.md
@@ -0,0 +1 @@
+# Models In-depth Overview