📖 fix(docs): almost done

README.md

@@ -4,7 +4,7 @@
 
    <h1 align="center">magnet</h1>
 
-   <h3 align="center"><a href="https://prismadic.github.io/magnet/">📖 docs</a> | 💻 <a href="https://github.com/Prismadic/magnet/tree/main/examples">examples</a></h3>
+   <h3 align="center"><a href="https://prismadic.github.io/magnet/">📖 docs</a> | 💻 <a href="https://github.com/Prismadic/magnet/tree/main/examples">examples</a> | 📓 <a href="https://prismadic.substack.com">substack</a></h3> 
 
    <p align="center">the small distributed language model toolkit</p>
    <p align="center"><i>⚡️ fine-tune state-of-the-art LLMs anywhere, rapidly ⚡️</i></p>

docs/index.rst

@@ -12,6 +12,122 @@ Welcome to magnet's documentation!
 
    modules
 
+.. raw:: html
+
+   <h3 align="center">
+
+don't forget to `check out <https://github.com/Prismadic/magnet/tree/main/examples>`_ the helpful 💻 examples
+
+.. raw:: html
+
+   </h3>
+
+.. raw:: html
+
+   <h3 align="center">
+
+the small distributed language model toolkit
+
+.. raw:: html
+
+   </h3>
+
+.. raw:: html
+
+   <h4 align="center">
+
+⚡️ fine-tune state-of-the-art LLMs anywhere, rapidly ⚡️
+
+.. raw:: html
+
+   </h4>
+
+🧬 Installation
+---------------
+
+.. code:: bash
+
+   pip install llm-magnet
+
+or
+
+.. code:: bash
+
+   python3 setup.py install
+
+🔮 features
+-----------
+
+.. raw:: html
+
+   <center>
+
+.. raw:: html
+
+   </center>
+
+-  ⚡️ **It’s Fast**
+
+   -  fast on consumer hardware
+   -  \ *very* fast on Apple Silicon
+   -  \ **extremely** fast on ROCm/CUDA
+
+-  🫵 **Automatic or your way**
+
+   -  rely on established transformer patterns to let ``magnet`` do the
+      work
+   -  keep your existing data processing functions, bring them to
+      ``magnet``!
+
+-  🛰️ **100% Distributed**
+
+   -  processing, embedding, storage, retrieval, querying, or inference
+      from anywhere
+   -  as much or as little compute as you need
+
+-  🧮 **Choose Inference Method**
+
+   -  HuggingFace
+   -  vLLM node
+   -  GPU
+   -  mlx
+
+-  🌎 **Huge Volumes**
+
+   -  handle gigantic amounts of data inexpensively
+   -  fault-tolerant by design
+   -  decentralized workloads
+
+-  🔐 **Secure**
+
+   -  JWT
+   -  Basic
+
+-  🪵 **World-Class Comprehension**
+
+   -  \ ``magnet`` optionally logs its own code as it’s executed (yes,
+      really)
+   -  build a self-aware system and allow it to learn from itself
+   -  emojis are the future
+
+learn more about how Prismadic uses 🧲
+------
+
+.. raw:: html
+
+   <h3 align="center">
+
+subscribe to our `substack <https://prismadic.substack.com>`_
+
+|A1| |A2|
+
+.. raw:: html
+
+   </h3>
+
+.. |A1| image:: https://github.com/Prismadic/.github/raw/main/profile/image_square.jpg
+.. |A2| image:: https://github.com/Prismadic/.github/raw/main/profile/accent_color_square.jpg
+
 Indices and tables
 ==================
 

docs/setup.rst

@@ -0,0 +1,7 @@
+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance:

setup.py

@@ -3,7 +3,7 @@
 setup(
     name='llm_magnet',
     version='0.0.9',
-    description="the small distributed language model toolkit. fine-tune state-of-the-art LLMs anywhere, rapidly."
+    description="the small distributed language model toolkit. fine-tune state-of-the-art LLMs anywhere, rapidly.",
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',
     install_requires=[