README / README.md
itlwas's picture
Update README.md
cc520d7 verified
---
title: README
emoji: 😻
colorFrom: indigo
colorTo: yellow
sdk: static
pinned: false
---
# πŸš€ Welcome to the GGUF Model Community!
This is a central hub for users to discover, access, and contribute to a vast collection of quantized models in the GGUF format. We're building a vibrant space for exchanging, searching for, and sharing models that cater to diverse needs and requirements within the GGUF ecosystem.
## ✨ Why GGUF?
GGUF is a modern file format for storing models optimized for efficient inference, particularly on consumer-grade hardware. This makes it easier for researchers, developers, and hobbyists to experiment with and deploy large language models.
## 🀝 How to Join the Community
We're excited to welcome new contributors! To join our community, you should have **at least 80 quantized models in GGUF format** ready to share. This ensures active participation and contribution to the collective knowledge base.
Once you meet this requirement, please reach out to us [insert method of contacting, e.g., via the Discussions tab, a specific user, etc.]. We'll be happy to discuss your application and welcome you aboard!
## 🎁 What We Offer
* **A Comprehensive Collection of GGUF Models:** Find models tailored for various tasks, sizes, and architectures.
* **A Platform for Sharing and Discovery:** Contribute your models and explore the contributions of others.
* **A Thriving Community:** Connect with like-minded individuals passionate about GGUF and its potential.
* **Organized Collections for Easy Navigation:** Browse models categorized by architecture, application, and more.
* **Increased Visibility for Your Models:** Sharing your models within the community increases their discoverability and potential impact.
## βž• Adding Models to Category-Specific Collections (Model Families)
Community members have the privilege of contributing models from their personal accounts to the community's carefully curated, category-specific collections. These collections focus on particular model architectures or families.
A model can be included in a category-specific collection if it meets **one** of the following criteria:
1. **Exact Match:** The model is the specified foundational model itself (e.g., Llama-3-8B-GGUF).
2. **Based On:** The model is a fine-tuned or adapted version of the specified foundational model (e.g., Llama-3-Tulu-3-8B-GGUF).
**Examples of Category-Specific Collections:**
* πŸ¦™ **Llama:** Dedicated to Llama family of models.
* ✨ **Gemma:** Dedicated to Gemma family of models.
* πŸ¦‰ **Mistral:** Dedicated to Mistral family of models.
## βž• Creating General Collections (Thematic Groupings)
In addition to contributing to existing category-specific collections, members can create **general collections** to group different models under a common theme or application.
**Examples of General Collections:**
* πŸ’¬ **Chat:** Models optimized for conversational AI and chatbot applications.
* πŸ›‘οΈ **Guard:** Models designed for identifying and mitigating harmful or unsafe content, promoting responsible AI.
* 🧠 **Reasoning:** Models that excel at logical reasoning, problem-solving, and knowledge application.
**Collection Naming Convention:**
Each collection **must** adhere to the following naming convention: `[Emoji][Name]`. For example: `πŸ’¬Chat`.
* Choose an emoji that visually represents the collection's theme.
* Use a clear and descriptive name for the collection.
## πŸ’‘ Inspiration & Examples
Explore our existing collections for inspiration and guidance on how to organize and present your models: [Collections Page](https://hf.co/collections/itlwas)
This page provides a wealth of examples and showcases the different ways you can contribute to the community.
## πŸš€ Let's Build Together!
We eagerly anticipate your participation and contributions! Together, we can foster a vibrant and collaborative ecosystem for GGUF models. Feel free to reach out with any questions.
**Thank you for being a part of the GGUF Model Community!**