a1c00l commited on
Commit
3c11838
Β·
verified Β·
1 Parent(s): 5ffee01

Update WELCOME_README.md

Browse files
Files changed (1) hide show
  1. WELCOME_README.md +29 -7
WELCOME_README.md CHANGED
@@ -1,17 +1,39 @@
1
  # πŸ€– AI SBOM Generator
2
 
3
- Generate an AI Software Bill of Materials (AI SBOM) from Hugging Face models β€” powered by [CycloneDX](https://cyclonedx.org).
 
4
 
5
- πŸš€ **Try it live:**
6
- [https://huggingface.co/spaces/aetheris-ai/aibom-generator](https://huggingface.co/spaces/aetheris-ai/aibom-generator)
7
 
8
  ---
9
 
10
- ## 🐞 Found a Bug or Have Feedback?
11
 
12
- Please log an issue on our GitHub repo:
13
- πŸ‘‰ [https://github.com/aetheris-ai/aibom-generator/issues](https://github.com/aetheris-ai/aibom-generator/issues)
 
 
14
 
15
  ---
16
 
17
- This tool is open-source and actively maintained. Contributions and ideas are welcome!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # πŸ€– AI SBOM Generator
2
 
3
+ This is the official Hugging Face Space repository for the **AI SBOM Generator** β€” an open-source tool for generating AI Software Bills of Materials (AI SBOMs) in [CycloneDX](https://cyclonedx.org) format.
4
+ Official GitHub reporitory is here: [github.com/aetheris-ai/aibom-generator]](https://github.com/aetheris-ai/aibom-generator/)
5
 
6
+ πŸš€ **Try the tool live:**
7
+ πŸ‘‰ [huggingface.co/spaces/aetheris-ai/aibom-generator](https://huggingface.co/spaces/aetheris-ai/aibom-generator)
8
 
9
  ---
10
 
11
+ ## πŸ“¦ What It Does
12
 
13
+ - Extracts metadata from models hosted on Hugging Face πŸ€—
14
+ - Generates an AI SBOM in JSON format based on CycloneDX 1.6
15
+ - Assesses metadata completeness and provides improvement tips
16
+ - Supports model cards, training data, evaluation, and usage metadata
17
 
18
  ---
19
 
20
+ ## πŸ›  Features
21
+
22
+ - Human-readable SBOM view
23
+ - JSON download
24
+ - Completeness scoring and recommendations
25
+ - AI-assisted enhancements (optional)
26
+
27
+ ---
28
+
29
+ ## 🐞 Found a Bug or Have an Improvement Rerquest?
30
+
31
+ Please help us improve!
32
+
33
+ ➑ [Log an issue on GitHub](https://github.com/aetheris-ai/aibom-generator/issues)
34
+
35
+ ---
36
+
37
+ ## πŸ“„ License
38
+
39
+ This project is open-source and available under the [MIT License](LICENSE).