Skip to content

Commit 1a539d3

Browse files
mxchinegodmxchinegod
committed
From refs/heads/main c6d6ad0 
0 parents  commit 1a539d3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+14509
-0
lines changed

‎.buildinfo

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

‎.nojekyll

Whitespace-only changes.

‎README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#GitHub Pages
2+
3+
Last update of sphinx html documentation from [c6d6ad0](https://github.com/Prismadic/magnet/tree/c6d6ad063411505ca469c58c96cb66b0df2cc47a)

‎_modules/index.html

+272
Large diffs are not rendered by default.

‎_modules/magnet/ic/field.html

+642
Large diffs are not rendered by default.

‎_modules/magnet/ize/filings.html

+513
Large diffs are not rendered by default.

‎_modules/magnet/ize/memory.html

+473
Large diffs are not rendered by default.

‎_modules/magnet/utils/data_classes.html

+368
Large diffs are not rendered by default.

‎_modules/magnet/utils/globals.html

+534
Large diffs are not rendered by default.

‎_modules/magnet/utils/huggingface.html

+304
Large diffs are not rendered by default.

‎_modules/magnet/utils/markdown.html

+272
Large diffs are not rendered by default.

‎_modules/magnet/utils/milvus.html

+463
Large diffs are not rendered by default.

‎_modules/magnet/utils/prompts.html

+298
Large diffs are not rendered by default.

‎_sources/index.rst.txt

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
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

‎_sources/magnet.ic.rst.txt

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
magnet.ic package
2+
=================
3+
4+
Submodules
5+
----------
6+
7+
magnet.ic.field module
8+
----------------------
9+
10+
.. automodule:: magnet.ic.field
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+

‎_sources/magnet.ize.rst.txt

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
magnet.ize package
2+
==================
3+
4+
Submodules
5+
----------
6+
7+
magnet.ize.filings module
8+
-------------------------
9+
10+
.. automodule:: magnet.ize.filings
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
magnet.ize.memory module
16+
------------------------
17+
18+
.. automodule:: magnet.ize.memory
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎_sources/magnet.ron.rst.txt

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
magnet.ron package
2+
==================
3+
4+
Submodules
5+
----------
6+
7+
magnet.ron.llm module
8+
---------------------
9+
10+
.. automodule:: magnet.ron.llm
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+

‎_sources/magnet.rst.txt

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
magnet package
2+
==============
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 5
9+
10+
magnet.ic
11+
magnet.ize
12+
magnet.ron
13+
magnet.utils

‎_sources/magnet.utils.mlx.rst.txt

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
magnet.utils.mlx package
2+
========================
3+
4+
Submodules
5+
----------
6+
7+
magnet.utils.mlx.mistral module
8+
-------------------------------
9+
10+
.. automodule:: magnet.utils.mlx.mistral
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:

‎_sources/magnet.utils.rst.txt

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
magnet.utils package
2+
====================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
magnet.utils.mlx
11+
12+
Submodules
13+
----------
14+
15+
magnet.utils.data\_classes module
16+
---------------------------------
17+
18+
.. automodule:: magnet.utils.data_classes
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
magnet.utils.globals module
24+
---------------------------
25+
26+
.. automodule:: magnet.utils.globals
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
magnet.utils.huggingface module
32+
-------------------------------
33+
34+
.. automodule:: magnet.utils.huggingface
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
magnet.utils.local module
40+
-------------------------
41+
42+
.. automodule:: magnet.utils.local
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
magnet.utils.markdown module
48+
----------------------------
49+
50+
.. automodule:: magnet.utils.markdown
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
magnet.utils.milvus module
56+
--------------------------
57+
58+
.. automodule:: magnet.utils.milvus
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
magnet.utils.prompts module
64+
---------------------------
65+
66+
.. automodule:: magnet.utils.prompts
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+

‎_sources/modules.rst.txt

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
magnet
2+
==========
3+
4+
.. toctree::
5+
:maxdepth: 5
6+
7+
magnet.ic
8+
magnet.ize
9+
magnet.ron
10+
magnet.utils

‎_sources/setup.rst.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
setup module
2+
============
3+
4+
.. automodule:: setup
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

0 commit comments

Comments
 (0)