Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Added ML-BOM examples #50

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

galmo-noma
Copy link

Added basic examples for foundation model, open source model, and dataset

@galmo-noma galmo-noma force-pushed the feature/add-ml-bom-to-examples branch from 34dcd38 to a5b7683 Compare December 4, 2024 08:45
Copy link
Member

@jkowalleck jkowalleck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding MLBOM, @galmo-noma . 👍

Could you modify your change request according to the remarks below?

README.md Outdated Show resolved Hide resolved
@jkowalleck jkowalleck marked this pull request as draft December 4, 2024 10:23
@jkowalleck jkowalleck marked this pull request as ready for review December 4, 2024 10:26
}
],
"tags": [
"task_categories:text-generation",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these values "tags" or are you intending to use properties which are name value pairs. These values seem to be hugging face specific which include the category:value.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Converted these values to "properties", let me know if this is what you had in mind

},
"components": [
{
"type": "data",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a data component but does not include a data property. Data components should include the data property, Without it, the consumer does not know what kind of data this is (e.g. configuration, source code, dataset, etc). Refer to https://cyclonedx.org/docs/1.6/json/#components_items_data

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added data property. I noticed it includes also a contents.url property. Should I put the huggingface link here, in externalReferences.url, or both?

"name": "Noma Security Inc."
}
},
"components": [
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to include a data subcomponent within the machine-learning-model? If so, that would tell the consumer information about the data used in this foundation model.

This component does not include the modelCard property, which it should.

Refer to:

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I was struggling to find what interesting information about GPT-4o should we add to the modelCard, since we are not accessible to the datasets it was trained on, to the complete ethical considerations, etc . I added a proposal of describing the model architecture, and the inputs & outputs. let me know what do you think :)

  2. Maybe I misunderstood, but as far as I understand, components that are not typed data, should not have the data property defined. Can you please advise?
    (quote from here)

},
"components": [
{
"type": "machine-learning-model",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same issue here. The type does not have a modelCard property. And there should ideally be a data subcomponent.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I added modelCard that includes the datasets this huggingface model was trained on
  2. (Same as above) Maybe I misunderstood, but as far as I understand, components that are not typed data, should not have the data property defined. Can you please advise?
    (quote from here)

@galmo-noma galmo-noma requested a review from a team as a code owner December 10, 2024 16:43
Copy link
Author

@galmo-noma galmo-noma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the time making those comments :)

}
],
"tags": [
"task_categories:text-generation",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Converted these values to "properties", let me know if this is what you had in mind

},
"components": [
{
"type": "data",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added data property. I noticed it includes also a contents.url property. Should I put the huggingface link here, in externalReferences.url, or both?

"name": "Noma Security Inc."
}
},
"components": [
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I was struggling to find what interesting information about GPT-4o should we add to the modelCard, since we are not accessible to the datasets it was trained on, to the complete ethical considerations, etc . I added a proposal of describing the model architecture, and the inputs & outputs. let me know what do you think :)

  2. Maybe I misunderstood, but as far as I understand, components that are not typed data, should not have the data property defined. Can you please advise?
    (quote from here)

},
"components": [
{
"type": "machine-learning-model",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I added modelCard that includes the datasets this huggingface model was trained on
  2. (Same as above) Maybe I misunderstood, but as far as I understand, components that are not typed data, should not have the data property defined. Can you please advise?
    (quote from here)

@galmo-noma galmo-noma force-pushed the feature/add-ml-bom-to-examples branch from 7954269 to 64378ba Compare December 10, 2024 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants