Update README.md

Readme needed some love.

README.md

@@ -10,6 +10,127 @@ New Prompt Template.
 
 ---
 
+---
+license: apache-2.0
+---
+
+**MermaidLLama: Unleashing the Power of Llama 3 - 8 Billion Parameters**
+
+Introducing Mermaid-LLama-3-8B, a robust language model designed for Python code understanding and crafting captivating story flow maps. 
+With a petite 8.3 billion parameters, this model builds on the success of LLama 3's 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 to better solve problems.
+
+2. **Storytelling Capabilities:**
+   - Converts narrative inputs into captivating Mermaid Diagrams.
+   - Maps character interactions, plot developments, and narrative arcs.
+
+3. **Unmatched Performance:**
+   - Surpasses GPT-4 in generating well-organized and detailed Mermaid Diagrams, its not even a competition Mermaid's do it better.🧜‍♀️
+
+4. **Training Insights:**
+   - Trained on a diverse dataset, including 800 unique, hand curated Mermaid Graph examples utilizing 478 complete python programs (hand tested each program) rather than code snippets.
+   - Exhibits emergent properties in story-to-flow map translations and step by step instruction flow maps to which it was not trained for.
+   - Adaptable and willing to be Prompt Engineered for your specific utilization.
+
+**Collaboration:**
+
+Mermaid is open to collaboration to further enhance its capabilities. 
+
+If you're interested in contributing or collaborating, feel free to reach out to [email protected]. 
+Your expertise could play a pivotal role in refining Mermaid.
+
+**Example Use Cases:**
+
+- **Code Documentation:**
+  Developers can use Mermaid 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 create visual project flow maps, facilitating effective communication and planning among team members.
+
+- **Learning Python:**
+  Students and beginners can visually understand Python code structures, enhancing their learning experience.
+
+- **Game Design:**
+  Game developers can utilize Mermaid for visualizing game storylines, ensuring a coherent narrative structure and character development.
+
+**Proof of Concept:**
+
+Mermaid 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:
+
+Exciting times ahead as we delve into the MermaidLLama revolution! 🚀
+
+# Training:
+LoRA Rank
+- 2048
+
+LoRA Alpha
+- 4096
+
+Batch Size
+- 1
+
+Micro Batch Size
+- 1
+
+Cutoff Length
+- 4096
+
+Save every n steps
+- 1000
+
+Epochs
+- 3
+
+Learning Rate
+- 1e-6
+
+LR Scheduler
+- cosine
+
+
+Target Modules
+▼
+- Enable q_proj
+- Enable v_proj
+- Enable k_proj
+- Enable o_proj
+- Enable gate_proj
+- Enable down_proj
+- Enable up_proj
+
 Example of what you would send to my model to get a flow graph that ends with ``` every time.
 
-https://drive.google.com/file/d/1z1QM9KZdg_VeH-tGwIY-cyxDas0ucnKc/view?usp=sharing
+https://drive.google.com/file/d/1z1QM9KZdg_VeH-tGwIY-cyxDas0ucnKc/view?usp=sharing
+---
+
+Start by downloading one of my models.
+![0 TroyDoesAI GIF](Mermaid_ShowCase/0_TroyDoesAI.gif)
+
+Load the model.
+![1 Load Model in 4-bit Show Example Use GIF](Mermaid_ShowCase/1_LoadModel_in_4bit_Show_Example_Use.gif)
+
+Inference the model using my prompt template replacing your instruction and input to generate a Mermaid code block,
+that can be viewed in the Mermaid Live Editor or Using the Mermaid CLI tool directly creating an image of the flow map.
+More on the cli tool here: https://github.com/mermaid-js/mermaid-cli
+
+![2 Loaded Model in Full Precision 16-bit Show Inference and Mermaid Live Editor GIF](Mermaid_ShowCase/2_Loaded_Model_in_Full_Precision_16bit_Show_Inference_and_Mermaid_Live_editor.gif)
+
+Here We Open the additional VLLM GUI Program I wrote for the example, while still running the Mermaid-Llama-8B to compare the flow diagram to the actual program.
+![3 Open The Program VLLM Program With Full Precision Mermaid-Llama-8B Running to Evaluate Flow Map GIF](Mermaid_ShowCase/3_Open_The_Program_VLLM_Program_With_Full_Precision_Mermaid-Llama-8B-Running_to_evaluate_flow_map.gif)
+
+# More on my cute VLLM Class and inference GUI.
+![Python RtdBsaz8gy GIF](Mermaid_ShowCase/python_RtdBsaz8gy.gif)