From refs/heads/main 2445e4f

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ced2ed8930753438f7bfc8caa2ddd2f8
+tags: 645f666f9bcd5a90fca523b33c5a78b7

README.md

@@ -0,0 +1,3 @@
+#GitHub Pages
+
+Last update of sphinx html documentation from [2445e4f](https://github.com/Prismadic/magnet/tree/2445e4fa74e65d4738bb85f30d6ec7147bae4330)

_sources/index.rst.txt

@@ -0,0 +1,171 @@
+.. magnet documentation master file, created by
+   sphinx-quickstart on Fri Dec 22 18:10:22 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. raw:: html
+
+   <h1 align="center">
+
+   Welcome to the 🧲 docs
+
+.. raw:: html
+
+   </h1>
+
+|DIV|
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Packages & useful classes
+
+   magnet.ic
+   magnet.ize
+   magnet.ron
+   magnet.utils
+
+|DIV|
+
+.. raw:: html
+
+   <h1 align="center">
+
+magnet
+=======
+
+.. raw:: html
+
+   </h1>
+
+.. 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
+
+   <h3 align="center">
+
+|NET|
+
+.. raw:: html
+
+   </h3>
+
+.. raw:: html
+
+   <h4 align="center">
+
+⚡️ fine-tune state-of-the-art LLMs anywhere, rapidly ⚡️
+
+.. raw:: html
+
+   </h4>
+
+🧬 Installation
+----------------
+
+|DIV|
+
+.. code:: bash
+
+   pip install llm-magnet
+
+or
+
+.. code:: bash
+
+   python3 setup.py install
+
+🔮 features
+----------------
+
+|DIV|
+
+-  ⚡️ **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
+
+.. raw:: html
+
+   <h3 align="center">
+
+learn more about how Prismadic uses 🧲
+
+subscribe to our `substack <https://prismadic.substack.com>`_
+
+.. raw:: html
+
+   </h3>
+
+
+|A1| |A2|
+
+Indices and tables
+----------------
+
+|DIV|
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. |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
+.. |NET| image:: https://github.com/Prismadic/magnet/raw/main/clustered_bidirectional.png
+.. |DIV| image:: https://github.com/Prismadic/magnet/raw/ef68535ecee236ff007638afa56de538b8fafd1a/divider.png

_sources/magnet.ic.rst.txt

@@ -0,0 +1,14 @@
+magnet.ic package
+=================
+
+Submodules
+----------
+
+magnet.ic.field module
+----------------------
+
+.. automodule:: magnet.ic.field
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

_sources/magnet.ize.rst.txt

@@ -0,0 +1,21 @@
+magnet.ize package
+==================
+
+Submodules
+----------
+
+magnet.ize.filings module
+-------------------------
+
+.. automodule:: magnet.ize.filings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+magnet.ize.memory module
+------------------------
+
+.. automodule:: magnet.ize.memory
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/magnet.ron.rst.txt

@@ -0,0 +1,14 @@
+magnet.ron package
+==================
+
+Submodules
+----------
+
+magnet.ron.llm module
+---------------------
+
+.. automodule:: magnet.ron.llm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

_sources/magnet.rst.txt

@@ -0,0 +1,13 @@
+magnet package
+==============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 5
+
+   magnet.ic
+   magnet.ize
+   magnet.ron
+   magnet.utils

_sources/magnet.utils.mlx.rst.txt

@@ -0,0 +1,13 @@
+magnet.utils.mlx package
+========================
+
+Submodules
+----------
+
+magnet.utils.mlx.mistral module
+-------------------------------
+
+.. automodule:: magnet.utils.mlx.mistral
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/magnet.utils.rst.txt

@@ -0,0 +1,70 @@
+magnet.utils package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   magnet.utils.mlx
+
+Submodules
+----------
+
+magnet.utils.data\_classes module
+---------------------------------
+
+.. automodule:: magnet.utils.data_classes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+magnet.utils.globals module
+---------------------------
+
+.. automodule:: magnet.utils.globals
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+magnet.utils.huggingface module
+-------------------------------
+
+.. automodule:: magnet.utils.huggingface
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+magnet.utils.local module
+-------------------------
+
+.. automodule:: magnet.utils.local
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+magnet.utils.markdown module
+----------------------------
+
+.. automodule:: magnet.utils.markdown
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+magnet.utils.milvus module
+--------------------------
+
+.. automodule:: magnet.utils.milvus
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+magnet.utils.prompts module
+---------------------------
+
+.. automodule:: magnet.utils.prompts
+   :members:
+   :undoc-members:
+   :show-inheritance:
+

_sources/modules.rst.txt

@@ -0,0 +1,10 @@
+magnet
+==========
+
+.. toctree::
+   :maxdepth: 5
+
+   magnet.ic
+   magnet.ize
+   magnet.ron
+   magnet.utils

_sources/setup.rst.txt

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