itlwas commited on
Commit
cc520d7
·
verified ·
1 Parent(s): fe45ebf

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +51 -23
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 place where users can easily find and access a large collection of quantized models in GGUF format. We create a space for exchanging and searching for models that meet any needs and requirements.
13
 
14
- ## How to Join
15
 
16
- To join, you must have more than 80 quantized models in GGUF format. Once you meet this requirement, feel free to apply and become a part of our growing community.
17
 
18
- ## What We Offer
19
 
20
- - A large collection of GGUF models for any purpose
21
- - A space for sharing, exchanging, and discovering models
22
- - A community of like-minded people working with GGUF format models
23
 
24
- ## Adding Models to Category-Specific Collections
25
 
26
- All community members have the right to contribute models from their accounts to the community's category-specific collections. A model can be added to a collection if it either:
27
 
28
- 1. Is the specified model itself (e.g., Llama-3.1-8B), or
29
- 2. Is based on that model (e.g., Llama-3.1-Tulu-3-8B).
 
 
 
30
 
31
- Examples of category-specific collections include:
32
- - 🦙Llama
33
- - ✨Gemma
34
 
35
- These collections focus on specific models or model families.
36
 
37
- ## Creating General Collections
38
 
39
- Members can also create **general collections**, which bring together different models under a broader theme. For example:
40
- - 💬Chat: Models optimized for conversational AI
41
- - 🛡️Guard: Models designed for identifying harmful or unsafe content
42
 
43
- Each collection must have an emoji at the beginning of its name, followed by the collection's title in the format `[Emoji][Name]`.
44
 
45
- You can explore existing collections for inspiration and reference on [this page](https://hf.co/collections/itlwas).
 
 
46
 
47
- We look forward to seeing you join and contribute to the community!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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!**