Skip to content

Commit d39c306

Browse files
docs: update README to improve clarity and formatting of current and future work sections
1 parent cbeb185 commit d39c306

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,21 @@ Work-in-progress Go CLI that scans a repository for **basic Hugging Face model u
99

1010
What works today:
1111

12-
- Basic scanning for Hugging Face model IDs in Python-like sources via `from_pretrained("...")`.
13-
- AIBOM generation per detected model in JSON or XML.
14-
- Hugging Face Hub API fetch to populate metadata fields.
15-
- Hugging Face Repo README fetch to populate more metadata fields.
16-
- Completeness scoring and validation of existing AIBOM files.
17-
- Interactive or file based metadata enrichment.
12+
- Basic scanning for Hugging Face model IDs in Python-like sources via `from_pretrained("...")`
13+
- AIBOM generation per detected model in JSON or XML
14+
- Hugging Face Hub API fetch to populate metadata fields
15+
- Hugging Face Repo README fetch to populate more metadata fields
16+
- Completeness scoring and validation of existing AIBOM files
17+
- Interactive or file based metadata enrichment
18+
- Data components with dataset fetchers and linking them in the AIBOM
1819

1920
What is future work:
2021

21-
- Improving the scanner beyond the current regex-based Hugging Face detection.
22-
- Implementing data components with dataset fetchers and linking them in the AIBOM.
23-
- Implementing the possibility to merge AIBOMs with existing sboms from a different source.
24-
- Implementing the possibility to sign AIBOMs with cosign.
22+
- Updating the UI to utilise Bubbletea library
23+
- Enhancing the resulting BOMs to include correct dependencies and BOMrefs
24+
- Improving the scanner beyond the current regex-based Hugging Face detection
25+
- Implementing the possibility to merge AIBOMs with existing sboms from a different source
26+
- Implementing the possibility to sign AIBOMs with cosign
2527
- Implementing check-vuln command to check AI vulnerability databases
2628
- Implementing AIBOM generation based of model files not on Hugging Face
2729

0 commit comments

Comments
 (0)