InferenceIllusionist commited on
Commit
da57466
1 Parent(s): c53ee6e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +97 -3
README.md CHANGED
@@ -1,3 +1,97 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ pipeline_tag: text-generation
4
+ tags:
5
+ - Visualizations
6
+ - MilkDrop
7
+ ---
8
+ > [!WARNING]
9
+ ><b>⚠️ Epilepsy Warning:</b> This model may generate visuals with flashing lights. Viewer discretion is advised for those with photosensitive epilepsy.
10
+
11
+ <div style="text-align: center;">
12
+ <h2>MilkDropLM-7b-v0.3</h2>
13
+ </div>
14
+
15
+ <p align="center">
16
+ <img src="https://huggingface.co/InferenceIllusionist/MilkDropLM-7b-v0.3/resolve/main/MilkDropLM-7b-v0.03%20Model%20Card%20-%20Preview.gif" width="600"/>
17
+ </p>
18
+
19
+ ## Background
20
+ <b>MilkDropLM-7b-v0.3</b> is a state-of-the-art language model designed to revolutionize the process of creating visually stunning MilkDrop presets. This model has been trained on a carefully curated dataset of 10,000+ examples encompassing the most exceptional MilkDrop presets available.
21
+
22
+ What is MilkDrop? It’s a music visualization engine which reacts in real time to the music. MilkDrop has a long 23 year history, has been ported to numerous systems, and a robust community of users that have made over 52,000 original presets. Today, there is a new generation of artists using the NestDrop app within their live concert performances.
23
+
24
+ What sets MilkDropLM apart is its unique ability to understand and generate the intricate, domain-specific scripting language used in MilkDrop presets. These scripts are frequently a blend of mathematical expressions and equations which traditional programming languages cannot easily replicate. MilkDropLM has overcome this challenge and can produce presets that are both mathematically precise and artistically captivating.
25
+
26
+ The result is a tool that empowers users to create visuals without having to necessarily know how to write shaders from scratch. Whether you're a programmer or preset author, newcomer or seasoned pro, MilkdropLM offers an intuitive and powerful way to bring your visions to life.
27
+
28
+ We’ve been grappling with an interesting challenge while working on this project. <b>How do we teach an LLM the various concepts that exist beyond our linguistic frameworks?</b> Since MilkdropLM has been trained on a human curated dataset which connects presets to categories, the code within the presets is in theory linked to artistic concepts that it would otherwise not make by itself.
29
+
30
+ MilkdropLM has made hidden connections to the code within the presets and likely understands the overall latent space. And yet MilkdropLM is a text based model and therefore cannot experience the resulting rendered visuals. So we’re left with an interesting middle ground where the model has a deep understanding of the preset code and the human can see the thematic connections between the various presets in the dataset, but will the model be able to make these same connections? Can the model be given a complex text description of a scene and create a wholly original preset? How far can the model interpolate and extrapolate within this domain? Can the model convert Shadertoy, Processing, or GLSL code into the MilkDrop format? But this isn’t just a thought experiment, since the results are directly applicable to the VJ community which already widely uses NestDrop for concerts worldwide.
31
+
32
+ Explore the potential of our early alpha language model and shape its development with your feedback. The variety of potential presets to explore is boundless since there are quadrillions of possible permutations, so jump in and see your experiments visualized in MilkDrop!
33
+
34
+ ## Training Methodology
35
+
36
+ The training process for MilkDropLM v0.3 was thorough, involving a carefully hand curated dataset of 10,000+ high-quality MilkDrop presets. We have invested significant effort in creating a comprehensive taxonomy of MilkDrop presets, which served as the foundation for the training dataset.
37
+
38
+ To ensure the quality and diversity of the training examples, we applied rigorous criteria to select only the most exceptional presets and also categorize them. The scripts were then transposed into ShareGPT format and paired with prompts which included a category and sub-category, allowing for a more nuanced understanding of the relationships between different elements within the presets.
39
+
40
+ One of the key challenges in training MilkDropLM was handling the unique syntax and structure of the MilkDrop scripting language. To address this, we trained on top of the nimble yet powerful Qwen-Coder-7b-Instuct model. This allowed us to build from the strong foundation of Qwen’s powerful language and programming capabilities.
41
+
42
+ Furthermore, to maximize the utility of MilkDropLM, we ensured that the model’s output follows the correct formatting.The presets generated by MilkDropLM are presented in markdown code blocks, making them easy to read, edit, and integrate into various projects. This aspect ensures that users can seamlessly incorporate MilkDropLM into their workflows without any hassle.
43
+
44
+ ## Original Model Weights
45
+ - [BF16](https://huggingface.co/InferenceIllusionist/MilkDropLM-7b-v0.3) - Full Precision, not required if running inference only
46
+ ## Suggested Workflow
47
+
48
+ Use your favorite LLM front-end app for inference (such as text-gen-web-ui, llama.cpp, kobold.cpp, LM Studio, etc). Here are the recommended settings for this model:
49
+
50
+ * Temperature: 0.3 (lower further to improve output at the cost of creativity)
51
+ * Top K Sampling: 20
52
+ * Top P Sampling: 0.8
53
+ * Min P Sampling: 0.05
54
+ * Repetition Penalty: 1.05
55
+ * Context Length: 32768 (Mininum 16384)
56
+
57
+ After you've generated a MilkDrop preset, copy-and-paste it into a text file, and then save it using the `.milk` file format.
58
+ Move the `.milk` file into the presets folder of your Milkdrop app. We recommend using the NestDrop Classic app, which is freely available. (Make sure to close and reopen NestDrop to see your newly added presets.)
59
+
60
+ ## Text Prompt Suggestions
61
+ Since this model has an understanding of what a MilkDrop preset is, there are numerous ways to ask it to make or edit a preset. One powerful technique is to ask the model to create a preset in one of the categories or subcategories that we’ve trained it to understand. Such as the following text prompt: “Give me a Glowsticks milkdrop preset”. Below is a full list of the available categories and their subcategories:
62
+
63
+ ```
64
+ Dancer /// Aurora, Blobby Mirror, Blobby, Comet Mirror, Comet, Glowsticks Fast, Glowsticks Mirror, Glowsticks, Hatches Mirror, Hatches, Infect Mirror, Infect, Jello Mirror, Lasers, Murky Mirror, Murky, Nexus Mirror, Orbit Mirror, Orbit, Petals, Serpent, Shapes, Spinner Mirror, Spinner, Streamers, Swarm, Tree Branch, Wake Mirror, Wake, Whirl Mirror, Whirl, Wire
65
+ Drawing /// Dunes Mirror, Dunes, Explosions Mirror, Explosions, Feedback, Fractal Mirror, Fractal, Glimmer Mirror, Growth Mirror, Growth, Lasers, Liquid Mirror, Liquid, Maze, Rorschach Mirror, Rorschach, Trails Mirror, Trails, Viscera, Whirlpools Mirror, Whirlpools
66
+ Fractal /// Blobby, Core Mirror, Core Tunnel, Core, Grid, Horizon Mirror, Lattice Mirror, Lattice, Loops, Mandelbox, Nested Circle, Nested Dancer, Nested Ellipse, Nested Hexagon, Nested Pyramid, Nested Spiral Multiple, Nested Spiral, Nested Square, Nested Triangle, Pointy, Radial, Shine, Sierpinski, Trees, Wave Interference, Wings, Womb
67
+ Geometric /// Cathedral, Circles Nested, City, Cube Array, Cube Fly, Cube, Dots, Gears, Honeycomb, Landscape, Monster, Pyramids, Snowflakes, Sphere Array, Sphere Particles, Sphere Wild, Spiral Bounce, Squares Glass, Squares, Stripes Circle, Stripes Dance, Stripes Liquid, Stripes, Symbols, Torus Interior, Triangles Solo, Tunnel Fans, Tunnel Morph, Tunnel Spheres, Wire Circles, Wire Cube Trace, Wire Flower, Wire Grid, Wire Morph, Wire Orbits, Wire Parallel, Wire Sphere, Wire Spiral Flower, Wire Spiral, Wire Torus, Wire Trace Mirror, Wire Trace
68
+ Hypnotic /// Illusion Radiate, Illusion, Polar Closeup, Polar Mirror, Polar Rolling, Polar Static, Polar Warp, Radial Warp
69
+ Particles /// Blobby, Crystal, Grid, Orbit, Points Fast, Points Trails, Points, Swarm
70
+ Reaction /// Automata, Cloudy, Contagion, Crystalize, Dunes, Feedback, Growth, Liquid Blobby, Liquid Closeup, Liquid Gradient, Liquid Ripples, Liquid Simmering, Liquid Windy, Luma Mirror, Maze, Mountains, Rorschach, Viscera, Whirlpools, Windy
71
+ Sparkle /// Explosions, Glimmer Mirror, Glimmer Tunnel, Glimmer, Jewel, Mass Circles, Mass Squares, Mass Stars, Mass Triangles, Squares
72
+ Supernova /// Burst, Gas, Lasers, Orbits, Radiate, Shimmer, Stars
73
+ Waveform /// Spectrum, Wire Circular, Wire Flat Double, Wire Flat, Wire Flower, Wire Mirror, Wire Rising, Wire Spirograph, Wire Tangle, Wire Tunnel
74
+ ```
75
+
76
+ ## Examples of Generated Presets
77
+ <img src="https://huggingface.co/InferenceIllusionist/MilkDropLM-7b-v0.3/resolve/main/MilkDropLM-7b-v0.3%20Model%20Card%20-%20Image.png?download=true" width="1024"/>
78
+ Here are some curated examples that we generated using MilkDropLM v0.3. We used vLLM to do a batch render and output 3,176 presets. This was then hand curated to the best 130 presets. While this may seem like a large ratio (1 out of every 24) we argue that it’s a very good result. Additionally, since ISOSCELES curated the original dataset and has therefore previously viewed every preset within the training data, he can attest that each of these examples exhibit a unique aspect.
79
+
80
+ Some of the examples feel like a classic preset mashup and a few feel original. We have only scratched the surface of what’s possible.
81
+ [Download Example Presets](https://huggingface.co/InferenceIllusionist/MilkDropLM-7b-v0.3/tree/main/Generated%20Preset%20Examples)
82
+
83
+ ## Version History
84
+
85
+ - v0.01: Closed alpha release. Basic ability to draw shapes and waves.
86
+ - v0.02: Closed alpha release. Improved grasp of geometric elements, better variety and creativity in output.
87
+ - v0.3: Public alpha release. Optimized training hyperparameters & dataset, even more variety and creativity, better formatting. MilkDropLM can now use warp & comp shaders.
88
+
89
+ ## Alpha Release Notice
90
+ MilkDropLM v0.3 represents an exciting step forward in breathing fresh life into the 23 year history of MilkDrop. We are thrilled to share this powerful tool with you, but we want to emphasize that it is currently in the alpha stage of development. Hence this model likely has some rough edges and limitations, but we are committed to continuous improvement and welcome your feedback to help refine and enhance this model. With each iteration we aim to make MilkDropLM more user-friendly, reliable, and capable of producing previously unseen visuals.
91
+
92
+ We encourage users to approach MilkDropLM with a spirit of experimentation and discovery. While not all presets may be perfect, the potential for creating new visuals is immense. At this stage we recommend batch rendering out a few hundred presets so that you can get a better sense of what’s possible with this model.
93
+
94
+ Please don't hesitate to reach out with your thoughts and ideas. You can submit any feedback through community posts. Or, if you’ve created some interesting presets that you’d like to share then please head over to the Reddit community.
95
+
96
+ ## Acknowledgements
97
+ This project is the result of a collaboration between [ISOSCELES](https://www.instagram.com/isosceles.vj) and InferenceIllusionist. This was a unique meeting of minds since ISOSCELES brought his MilkDrop preset knowledge and experience in helping develop NestDrop for the VJ community, and InferenceIllusionist brought his vital experience in fine-tuning and quantizing LLMs. We stand on the shoulders of the many Milkdrop authors which have freely released their original presets for everyone to enjoy. Much respect!