diff --git a/README.md b/README.md index ced288e..c8487f8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

magnet

-

📖 docs | 💻 examples

+

📖 docs | 💻 examples | 📓 substack

the small distributed language model toolkit

⚡️ fine-tune state-of-the-art LLMs anywhere, rapidly ⚡️

diff --git a/docs/index.rst b/docs/index.rst index 1e00937..58bcc92 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,6 +12,122 @@ Welcome to magnet's documentation! modules +.. raw:: html + +

+ +don't forget to `check out `_ the helpful 💻 examples + +.. raw:: html + +

+ +.. raw:: html + +

+ +the small distributed language model toolkit + +.. raw:: html + +

+ +.. raw:: html + +

+ +⚡️ fine-tune state-of-the-art LLMs anywhere, rapidly ⚡️ + +.. raw:: html + +

+ +🧬 Installation +--------------- + +.. code:: bash + + pip install llm-magnet + +or + +.. code:: bash + + python3 setup.py install + +🔮 features +----------- + +.. raw:: html + +
+ +.. raw:: html + +
+ +- ⚡️ **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 + +

+ +subscribe to our `substack `_ + +|A1| |A2| + +.. raw:: html + +

+ +.. |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 ================== diff --git a/docs/setup.rst b/docs/setup.rst new file mode 100644 index 0000000..552eb49 --- /dev/null +++ b/docs/setup.rst @@ -0,0 +1,7 @@ +setup module +============ + +.. automodule:: setup + :members: + :undoc-members: + :show-inheritance: diff --git a/setup.py b/setup.py index b4f56b4..19293db 100644 --- a/setup.py +++ b/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=[