Update README.md
Browse files
README.md
CHANGED
@@ -7,42 +7,63 @@ massive thank you to [@silveroxides](https://huggingface.co/silveroxides) for ph
|
|
7 |
|
8 |
#
|
9 |
> [!IMPORTANT]
|
10 |
-
> # MIR (Machine Intelligence Resource)
|
11 |
|
12 |
-
MIR
|
13 |
-
|
|
|
|
|
|
|
|
|
14 |
|
15 |
> [!NOTE]
|
16 |
> # mir : model . transformer . clip-l : stable-diffusion-xl
|
17 |
|
18 |
|
19 |
-
```
|
20 |
-
|
21 |
β β β β β
|
22 |
-
|
23 |
```
|
24 |
|
25 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
26 |
|
27 |
-
|
28 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
29 |
|
30 |
-
|
31 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
32 |
- Simplification of code for model-related logistics
|
33 |
- Rapid retrieval of resources and metadata
|
34 |
- Efficient and reliable compatability checks
|
35 |
- Organized hyperparameter management
|
36 |
|
37 |
-
|
38 |
-
>
|
39 |
-
>
|
40 |
> - Exact frameworks (SGM/LDM/RectifiedFlow) includes too few
|
41 |
> - Diffusion/Transformer are too broad, share and overlap resources
|
42 |
-
> - Multimodal models complicate content terms (Text/Image/Vision/etc)
|
43 |
-
> - HF.CO names do all of this & become inconsistent across folders/files
|
44 |
-
> - Development credit often shared
|
45 |
-
> - Paper heredity would be a neat tree, but it complicates retrieval
|
46 |
> - Algorithms (esp application) are less common knowledge, vague, ~~and I'm too smooth-brain.~~
|
47 |
> - Impartiality
|
48 |
> </details>
|
|
|
7 |
|
8 |
#
|
9 |
> [!IMPORTANT]
|
10 |
+
> # MIR (Machine Intelligence Resource)<br><br>A naming schema for AIGC/ML work.
|
11 |
|
12 |
+
The MIR schema seeks to standardize and complete a hyperlinked network of model information, improving accessibility and reproducibility across the AI community.<br>
|
13 |
+
The work is inspired by:
|
14 |
+
- [AIR-URN](https://github.com/civitai/civitai/wiki/AIR-%E2%80%90-Uniform-Resource-Names-for-AI) project by [CivitAI](https://civitai.com/)
|
15 |
+
- [Spandrel](https://github.com/chaiNNer-org/spandrel/blob/main/libs/spandrel/spandrel/__helpers/registry.py) library's super-resolution registry
|
16 |
+
|
17 |
+
Example:
|
18 |
|
19 |
> [!NOTE]
|
20 |
> # mir : model . transformer . clip-l : stable-diffusion-xl
|
21 |
|
22 |
|
23 |
+
```
|
24 |
+
mir : model . lora . hyper : flux-1
|
25 |
β β β β β
|
26 |
+
[URI]:[Domain].[Architecture].[Implementation]:[Compatibility]
|
27 |
```
|
28 |
|
29 |
+
## Definitions:
|
30 |
+
|
31 |
+
Like other URI schema, the order of the identifiers roughly indicates their specificity from left (broad) to right (narrow)
|
32 |
+
### Domain
|
33 |
+
`dev`: Varying local neural network layers, in-training, pre-release, items under evaluation, likely in unexpected formats<br>
|
34 |
+
`model`: Static local neural network layers. Publicly released machine learning models with an identifier in the database<br>
|
35 |
+
`operations`: Varying global neural network attributes, algorithms, optimizations and procedures on models<br>
|
36 |
+
`info`: Static global neural network attributes, metadata with an identifier in the database<br>
|
37 |
|
38 |
+
### Architecture
|
39 |
+
Generative or deep learning system architectures.
|
40 |
+
`dit`: Diffusion transformer, typically Vision Synthesis
|
41 |
+
'unet': Unet diffusion structure
|
42 |
+
`art` : Autoregressive transformer, typically LLMs
|
43 |
+
`lora`: Low-Rank Adapter (may work with dit or transformer)
|
44 |
+
`vae`: Variational Autoencoder
|
45 |
+
etc
|
46 |
|
47 |
+
### Implementation
|
48 |
+
A broad definition spanning the field of techniques
|
49 |
+
|
50 |
+
### Compatability
|
51 |
+
Details of implementation based on version-breaking changes, configuration inconsistencies, or other conflicting indicators
|
52 |
+
|
53 |
+
### Goals
|
54 |
+
- Standard identification scheme for **ALL** fields of ML-related development
|
55 |
- Simplification of code for model-related logistics
|
56 |
- Rapid retrieval of resources and metadata
|
57 |
- Efficient and reliable compatability checks
|
58 |
- Organized hyperparameter management
|
59 |
|
60 |
+
> <details> <summary>Why not use `diffusion`/`sgm`, `ldm`/`text`/hf.co folder-structure/brand or trade name/preprint paper/development house/algorithm</summary>
|
61 |
+
>
|
|
|
62 |
> - Exact frameworks (SGM/LDM/RectifiedFlow) includes too few
|
63 |
> - Diffusion/Transformer are too broad, share and overlap resources
|
64 |
+
> - Multimodal models mix and complicate content terms (Text/Image/Vision/etc)
|
65 |
+
> - HF.CO names do all of this & become inconsistent across folders/files, neglect many important developments
|
66 |
+
> - Development credit often shared, [Paper heredity tree](https://www.connectedpapers.com/search?q=generative%20diffusion), super complicated
|
|
|
67 |
> - Algorithms (esp application) are less common knowledge, vague, ~~and I'm too smooth-brain.~~
|
68 |
> - Impartiality
|
69 |
> </details>
|