Update README.md

README.md

@@ -1,3 +1,64 @@
 ---
 license: apache-2.0
 ---
+
+Experiment Title: MermaidLLama vs Mistral: Testing the Power of 8 Billion Parameters
+---
+
+I'm thrilled to share a groundbreaking experiment comparing the capabilities of MermaidLLama, an 8.3 billion-parameter model based on LLaMA-PRO-Instruct, against Mistral, a 7-billion-parameter model. The motivation behind this test is to explore whether "bigger is better" when it comes to language models.
+
+**MermaidLLama: Unleashing the Power of 8 Billion Parameters**
+
+Introducing MermaidLLama, a robust language model designed for Python code understanding and crafting captivating story flow maps. With a staggering 8.3 billion parameters, this model builds on the success of LLaMA-PRO-Instruct ability to maintain versatility in programming, mathematical reasoning, and general language processing.
+
+**Key Features:**
+
+1. **Code Understanding:**
+   - Masters Python intricacies with finesse.
+   - Generates clear and accurate Mermaid Diagram Flow Charts.
+   - Ideal for developers seeking visual representations of their code's logic.
+
+2. **Storytelling Capabilities:**
+   - Converts narrative inputs into captivating Mermaid Diagrams.
+   - Maps character interactions, plot developments, and narrative arcs effortlessly.
+
+3. **Unmatched Performance:**
+   - Surpasses Mistral and even larger models like GPT-4 in generating well-organized and detailed Mermaid Diagrams for story flows.
+
+4. **Training Insights:**
+   - Trained on a diverse dataset, including 478 Python examples.
+   - Exhibits emergent properties in story-to-flow map translations.
+   - Adaptable and efficient in resource utilization.
+
+**Collaboration:**
+
+MermaidLLama is open to collaboration to further enhance its capabilities. The Alpaca-formatted dataset provides a unique foundation for understanding Python intricacies. If you're interested in contributing or collaborating, feel free to reach out to troydoesai@gmail.com. Your expertise could play a pivotal role in refining MermaidLLama.
+
+**Example Use Cases:**
+
+- **Code Documentation:**
+  Developers can use MermaidLLama to automatically generate visual flow charts from their Python code, aiding in documentation and code understanding.
+
+- **Storyboarding:**
+  Storytellers and writers can input their narrative and receive visually appealing Mermaid Diagrams, offering a structured overview of character interactions and plot progression.
+
+- **Project Planning:**
+  Project managers can leverage MermaidLLama to create visual project flow maps, facilitating effective communication and planning among team members.
+
+- **Learning Python:**
+  Students and beginners can use MermaidLLama to visually understand Python code structures, enhancing their learning experience.
+
+- **Game Design:**
+  Game developers can utilize MermaidLLama for visualizing game storylines, ensuring a coherent narrative structure and character development.
+
+**Proof of Concept:**
+
+MermaidLLama proves that innovation thrives in compact packages, delivering exceptional performance across diverse applications. Stay tuned for the release of the VSCode Extension that displays the Live Flow Map every time a user stops typing for more than 10 seconds.
+
+For best results, use full precision with one of the three different instruction types:
+
+- "instruction": "Create the mermaid diagram for the following code:"
+- "instruction": "Create the mermaid diagram for the following story:"
+- "instruction": "Create the mermaid diagram for the following:"
+
+Exciting times ahead as we delve into the MermaidLLama revolution! 🚀