|
| 1 | +.. magnet documentation master file, created by |
| 2 | + sphinx-quickstart on Fri Dec 22 18:10:22 2023. |
| 3 | + You can adapt this file completely to your liking, but it should at least |
| 4 | + contain the root `toctree` directive. |
| 5 | +
|
| 6 | +.. raw:: html |
| 7 | + |
| 8 | + <h1 align="center"> |
| 9 | + |
| 10 | + Welcome to the 🧲 docs |
| 11 | + |
| 12 | +.. raw:: html |
| 13 | + |
| 14 | + </h1> |
| 15 | + |
| 16 | +|DIV| |
| 17 | + |
| 18 | +.. toctree:: |
| 19 | + :maxdepth: 3 |
| 20 | + :caption: Packages & useful classes |
| 21 | + |
| 22 | + magnet.ic |
| 23 | + magnet.ize |
| 24 | + magnet.ron |
| 25 | + magnet.utils |
| 26 | + |
| 27 | +|DIV| |
| 28 | + |
| 29 | +.. raw:: html |
| 30 | + |
| 31 | + <h1 align="center"> |
| 32 | + |
| 33 | +magnet |
| 34 | +======= |
| 35 | + |
| 36 | +.. raw:: html |
| 37 | + |
| 38 | + </h1> |
| 39 | + |
| 40 | +.. raw:: html |
| 41 | + |
| 42 | + <h3 align="center"> |
| 43 | + |
| 44 | +don't forget to `check out <https://github.com/Prismadic/magnet/tree/main/examples>`_ the helpful 💻 examples |
| 45 | + |
| 46 | +.. raw:: html |
| 47 | + |
| 48 | + </h3> |
| 49 | + |
| 50 | +.. raw:: html |
| 51 | + |
| 52 | + <h3 align="center"> |
| 53 | + |
| 54 | +the small distributed language model toolkit |
| 55 | + |
| 56 | +.. raw:: html |
| 57 | + |
| 58 | + </h3> |
| 59 | + |
| 60 | +.. raw:: html |
| 61 | + |
| 62 | + <h3 align="center"> |
| 63 | + |
| 64 | +|NET| |
| 65 | + |
| 66 | +.. raw:: html |
| 67 | + |
| 68 | + </h3> |
| 69 | + |
| 70 | +.. raw:: html |
| 71 | + |
| 72 | + <h4 align="center"> |
| 73 | + |
| 74 | +⚡️ fine-tune state-of-the-art LLMs anywhere, rapidly ⚡️ |
| 75 | + |
| 76 | +.. raw:: html |
| 77 | + |
| 78 | + </h4> |
| 79 | + |
| 80 | +🧬 Installation |
| 81 | +---------------- |
| 82 | + |
| 83 | +|DIV| |
| 84 | + |
| 85 | +.. code:: bash |
| 86 | +
|
| 87 | + pip install llm-magnet |
| 88 | +
|
| 89 | +or |
| 90 | + |
| 91 | +.. code:: bash |
| 92 | +
|
| 93 | + python3 setup.py install |
| 94 | +
|
| 95 | +🔮 features |
| 96 | +---------------- |
| 97 | + |
| 98 | +|DIV| |
| 99 | + |
| 100 | +- ⚡️ **It’s Fast** |
| 101 | + |
| 102 | + - fast on consumer hardware |
| 103 | + - \ *very* fast on Apple Silicon |
| 104 | + - \ **extremely** fast on ROCm/CUDA |
| 105 | + |
| 106 | +- 🫵 **Automatic or your way** |
| 107 | + |
| 108 | + - rely on established transformer patterns to let ``magnet`` do the |
| 109 | + work |
| 110 | + - keep your existing data processing functions, bring them to |
| 111 | + ``magnet``! |
| 112 | + |
| 113 | +- 🛰️ **100% Distributed** |
| 114 | + |
| 115 | + - processing, embedding, storage, retrieval, querying, or inference |
| 116 | + from anywhere |
| 117 | + - as much or as little compute as you need |
| 118 | + |
| 119 | +- 🧮 **Choose Inference Method** |
| 120 | + |
| 121 | + - HuggingFace |
| 122 | + - vLLM node |
| 123 | + - GPU |
| 124 | + - mlx |
| 125 | + |
| 126 | +- 🌎 **Huge Volumes** |
| 127 | + |
| 128 | + - handle gigantic amounts of data inexpensively |
| 129 | + - fault-tolerant by design |
| 130 | + - decentralized workloads |
| 131 | + |
| 132 | +- 🔐 **Secure** |
| 133 | + |
| 134 | + - JWT |
| 135 | + - Basic |
| 136 | + |
| 137 | +- 🪵 **World-Class Comprehension** |
| 138 | + |
| 139 | + - \ ``magnet`` optionally logs its own code as it’s executed (yes, |
| 140 | + really) |
| 141 | + - build a self-aware system and allow it to learn from itself |
| 142 | + - emojis are the future |
| 143 | + |
| 144 | +.. raw:: html |
| 145 | + |
| 146 | + <h3 align="center"> |
| 147 | + |
| 148 | +learn more about how Prismadic uses 🧲 |
| 149 | + |
| 150 | +subscribe to our `substack <https://prismadic.substack.com>`_ |
| 151 | + |
| 152 | +.. raw:: html |
| 153 | + |
| 154 | + </h3> |
| 155 | + |
| 156 | + |
| 157 | +|A1| |A2| |
| 158 | + |
| 159 | +Indices and tables |
| 160 | +---------------- |
| 161 | + |
| 162 | +|DIV| |
| 163 | + |
| 164 | +* :ref:`genindex` |
| 165 | +* :ref:`modindex` |
| 166 | +* :ref:`search` |
| 167 | + |
| 168 | +.. |A1| image:: https://github.com/Prismadic/.github/raw/main/profile/image_square.jpg |
| 169 | +.. |A2| image:: https://github.com/Prismadic/.github/raw/main/profile/accent_color_square.jpg |
| 170 | +.. |NET| image:: https://github.com/Prismadic/magnet/raw/main/clustered_bidirectional.png |
| 171 | +.. |DIV| image:: https://github.com/Prismadic/magnet/raw/ef68535ecee236ff007638afa56de538b8fafd1a/divider.png |
0 commit comments