Open juhoinkinen opened 3 weeks ago
About @osma's suggestions in https://github.com/NatLibFi/Annif/issues/790#issuecomment-2137376118:
For example it could include the Annif version used for training, the backend, vocabulary name and size, possibly some of the hyperparameters / configuration settings as well.
<project-id>.cfg
files, accessible from the Files and versions tab, e.g. https://huggingface.co/NatLibFi/FintoAI-data-YSO/blob/main/yso-en.cfg, so I think they are not worth putting to the Model Card.Issues
6 New issues
0 Accepted issues
Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 99.65%. Comparing base (
3b5f7a1
) to head (125565e
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
@CodiumAI-Agent /review
⏱️ Estimated effort to review [1-5] | 3 |
🧪 Relevant tests | Yes |
🔒 Security concerns | No |
⚡ Key issues to review |
Possible Bug: Ensure that the upsert_modelcard function handles cases where project language data might be missing or malformed. The current implementation assumes that proj.vocab_lang is always available and valid. |
Data Integrity: The merging of languages in upsert_modelcard should handle duplicates and potential case sensitivity issues to avoid incorrect language tags in the Model Card. |
Possible Bug: Ensure that the upsert_modelcard function handles cases where project language data might be missing or malformed. > The current implementation assumes that proj.vocab_lang is always available and valid.
Good point by the AI, but I think the project language is always set if this point is reached...?
With this PR, when running
annif upload
:README.md
(Model Card) does not exist in the destination repository, thenREADME.md
is created with default contents and some metadata of the uploaded projects,README.md
exists, its metadata are updated as necessary.Closes #790.
The metadata includes these:
The Model Card text content is very minimal; it has just the repo name as the heading and info about how to download projects from the repo, see an example in https://huggingface.co/juhoinkinen/Annif-models-upload-testing.