Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
@@ -7,41 +7,69 @@ sdk: static
|
|
7 |
pinned: false
|
8 |
---
|
9 |
|
10 |
-
# Welcome to the GGUF Model Community!
|
11 |
|
12 |
-
This is a
|
13 |
|
14 |
-
##
|
15 |
|
16 |
-
|
17 |
|
18 |
-
##
|
19 |
|
20 |
-
|
21 |
-
- A space for sharing, exchanging, and discovering models
|
22 |
-
- A community of like-minded people working with GGUF format models
|
23 |
|
24 |
-
|
25 |
|
26 |
-
|
27 |
|
28 |
-
|
29 |
-
|
|
|
|
|
|
|
30 |
|
31 |
-
|
32 |
-
- 🦙Llama
|
33 |
-
- ✨Gemma
|
34 |
|
35 |
-
These collections focus on
|
36 |
|
37 |
-
|
38 |
|
39 |
-
|
40 |
-
-
|
41 |
-
- 🛡️Guard: Models designed for identifying harmful or unsafe content
|
42 |
|
43 |
-
|
44 |
|
45 |
-
|
|
|
|
|
46 |
|
47 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
7 |
pinned: false
|
8 |
---
|
9 |
|
10 |
+
# 🚀 Welcome to the GGUF Model Community!
|
11 |
|
12 |
+
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.
|
13 |
|
14 |
+
## ✨ Why GGUF?
|
15 |
|
16 |
+
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.
|
17 |
|
18 |
+
## 🤝 How to Join the Community
|
19 |
|
20 |
+
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.
|
|
|
|
|
21 |
|
22 |
+
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!
|
23 |
|
24 |
+
## 🎁 What We Offer
|
25 |
|
26 |
+
* **A Comprehensive Collection of GGUF Models:** Find models tailored for various tasks, sizes, and architectures.
|
27 |
+
* **A Platform for Sharing and Discovery:** Contribute your models and explore the contributions of others.
|
28 |
+
* **A Thriving Community:** Connect with like-minded individuals passionate about GGUF and its potential.
|
29 |
+
* **Organized Collections for Easy Navigation:** Browse models categorized by architecture, application, and more.
|
30 |
+
* **Increased Visibility for Your Models:** Sharing your models within the community increases their discoverability and potential impact.
|
31 |
|
32 |
+
## ➕ Adding Models to Category-Specific Collections (Model Families)
|
|
|
|
|
33 |
|
34 |
+
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.
|
35 |
|
36 |
+
A model can be included in a category-specific collection if it meets **one** of the following criteria:
|
37 |
|
38 |
+
1. **Exact Match:** The model is the specified foundational model itself (e.g., Llama-3-8B-GGUF).
|
39 |
+
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).
|
|
|
40 |
|
41 |
+
**Examples of Category-Specific Collections:**
|
42 |
|
43 |
+
* 🦙 **Llama:** Dedicated to Llama family of models.
|
44 |
+
* ✨ **Gemma:** Dedicated to Gemma family of models.
|
45 |
+
* 🦉 **Mistral:** Dedicated to Mistral family of models.
|
46 |
|
47 |
+
## ➕ Creating General Collections (Thematic Groupings)
|
48 |
+
|
49 |
+
In addition to contributing to existing category-specific collections, members can create **general collections** to group different models under a common theme or application.
|
50 |
+
|
51 |
+
**Examples of General Collections:**
|
52 |
+
|
53 |
+
* 💬 **Chat:** Models optimized for conversational AI and chatbot applications.
|
54 |
+
* 🛡️ **Guard:** Models designed for identifying and mitigating harmful or unsafe content, promoting responsible AI.
|
55 |
+
* 🧠 **Reasoning:** Models that excel at logical reasoning, problem-solving, and knowledge application.
|
56 |
+
|
57 |
+
**Collection Naming Convention:**
|
58 |
+
|
59 |
+
Each collection **must** adhere to the following naming convention: `[Emoji][Name]`. For example: `💬Chat`.
|
60 |
+
|
61 |
+
* Choose an emoji that visually represents the collection's theme.
|
62 |
+
* Use a clear and descriptive name for the collection.
|
63 |
+
|
64 |
+
## 💡 Inspiration & Examples
|
65 |
+
|
66 |
+
Explore our existing collections for inspiration and guidance on how to organize and present your models: [Collections Page](https://hf.co/collections/itlwas)
|
67 |
+
|
68 |
+
This page provides a wealth of examples and showcases the different ways you can contribute to the community.
|
69 |
+
|
70 |
+
## 🚀 Let's Build Together!
|
71 |
+
|
72 |
+
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.
|
73 |
+
|
74 |
+
|
75 |
+
**Thank you for being a part of the GGUF Model Community!**
|