Update README.md
Browse files
README.md
CHANGED
|
@@ -7,4 +7,87 @@ sdk: static
|
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
+
# Hugging Face FAU
|
| 11 |
+
|
| 12 |
+
Welcome to the **official Hugging Face organization page** for students, researchers, and enthusiasts from **Friedrich Alexander University Erlangen-Nürnberg (FAU)**! 🌟
|
| 13 |
+
|
| 14 |
+
Whether you're fine-tuning models, experimenting with VLMs (Vision-Language Models), building innovative datasets, or creating impactful Gradio Spaces — **this is your home base** for contributing to the open-source ML ecosystem as part of the FAU community. ❤️
|
| 15 |
+
|
| 16 |
+
---
|
| 17 |
+
|
| 18 |
+
## 🌍 What You Can Do Here
|
| 19 |
+
|
| 20 |
+
### 🧪 Fine-Tune and Share Your Models
|
| 21 |
+
If you're working on LLMs, VLMs, or other neural architectures, this is the place to:
|
| 22 |
+
- Upload your **trained or fine-tuned models**
|
| 23 |
+
- Share meaningful experiments
|
| 24 |
+
- Benchmark results and publish evaluations
|
| 25 |
+
- Collaborate with fellow FAU students
|
| 26 |
+
|
| 27 |
+
> 🔁 Tip: Always validate your models locally before uploading to avoid clutter and broken pipelines.
|
| 28 |
+
|
| 29 |
+
---
|
| 30 |
+
|
| 31 |
+
### 🎨 Build Amazing Hugging Face Spaces
|
| 32 |
+
Create interactive applications with:
|
| 33 |
+
- [Gradio](https://gradio.app/)
|
| 34 |
+
- Hugging Face `spaces` SDK
|
| 35 |
+
- Chatbots, demo UIs, document explorers, and much more!
|
| 36 |
+
|
| 37 |
+
> ✅ Keep it clean, creative, and collaborative.
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
+
### 📊 Contribute Creative and Useful Datasets
|
| 42 |
+
Whether it’s **research data**, **cleaned corpora**, or **synthetic datasets** you've generated using simulation or AI — feel free to:
|
| 43 |
+
- Host them here
|
| 44 |
+
- Provide clear usage guides
|
| 45 |
+
- Include metadata and intended use-cases
|
| 46 |
+
|
| 47 |
+
> 📚 Document everything — what it is, how it’s used, and any ethical considerations.
|
| 48 |
+
|
| 49 |
+
---
|
| 50 |
+
|
| 51 |
+
## 🧭 Guidelines and Best Practices
|
| 52 |
+
|
| 53 |
+
To ensure high quality and easy collaboration, please follow these essential practices:
|
| 54 |
+
|
| 55 |
+
- ✅ **Use clear and descriptive names** for your models, datasets, and spaces
|
| 56 |
+
- ✅ **Include thorough documentation** (README files, usage examples, dataset cards, model cards, etc.)
|
| 57 |
+
- ✅ **Test before publishing**: Ensure everything works as expected before pushing
|
| 58 |
+
- ✅ **Stick to open licenses**: Use [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0), [MIT](https://opensource.org/licenses/MIT), or other open-source licenses
|
| 59 |
+
- ❌ **Avoid uploading half-working or incomplete projects** without any context or documentation
|
| 60 |
+
- 💬 **Support your peers**: Comment, fork, and collaborate!
|
| 61 |
+
|
| 62 |
+
---
|
| 63 |
+
|
| 64 |
+
## 🤝 Get Involved and Contribute!
|
| 65 |
+
|
| 66 |
+
This space is only as powerful as **we make it together**. Whether you’re a beginner or a seasoned researcher:
|
| 67 |
+
- Contribute your work
|
| 68 |
+
- Ask questions
|
| 69 |
+
- Learn from others
|
| 70 |
+
- Build tools and demos that help the community
|
| 71 |
+
|
| 72 |
+
We’re here to grow **FAU’s open-source AI ecosystem** — one commit at a time. 🌱✨
|
| 73 |
+
|
| 74 |
+
---
|
| 75 |
+
|
| 76 |
+
## 🛠 Helpful Links
|
| 77 |
+
- 🔗 [FAU Homepage](https://www.fau.de/)
|
| 78 |
+
- 🧑🏫 [FAU Department of Computer Science](https://www.cs.fau.de/)
|
| 79 |
+
- 🤗 [Hugging Face Docs](https://huggingface.co/docs)
|
| 80 |
+
|
| 81 |
+
---
|
| 82 |
+
|
| 83 |
+
## 🫂 Maintainers and Contact
|
| 84 |
+
For questions, ideas, or help: <br>
|
| 85 |
+
📧 Contact us [**here**](mailto:zamal.babar.mohammed@fau.de) <br>
|
| 86 |
+
🌐 Organization Student Admin: [@zamal](https://huggingface.co/zamal)
|
| 87 |
+
|
| 88 |
+
---
|
| 89 |
+
|
| 90 |
+
Let’s build something great together.
|
| 91 |
+
Stay creative, stay kind, and keep building! 💙
|
| 92 |
+
|
| 93 |
+
— *The FAU Hugging Face Org Team*
|