Skip to content

Commit

Permalink
Added descriptions for ML learning types (#416)
Browse files Browse the repository at this point in the history
Closes #351
  • Loading branch information
stevespringett authored Mar 26, 2024
2 parents 22299d0 + ac3e662 commit 7fb317c
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 6 deletions.
5 changes: 5 additions & 0 deletions schema/bom-1.6.proto
Original file line number Diff line number Diff line change
Expand Up @@ -1155,10 +1155,15 @@ message ModelCard {

enum ModelParameterApproachType {
// buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX -- value `0` is a fallback(meaning "unspecified") in protobuf3. this usage here is an error, it shall be fixed with v2.0 of this very schema
// Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples.
MODEL_PARAMETER_APPROACH_TYPE_SUPERVISED = 0;
// Unsupervised machine learning involves training algorithms on unlabeled data to discover patterns, structures, or relationships without explicit guidance, allowing the model to identify inherent structures or clusters within the data.
MODEL_PARAMETER_APPROACH_TYPE_UNSUPERVISED = 1;
// Reinforcement learning is a type of machine learning where an agent learns to make decisions by interacting with an environment to maximize cumulative rewards, through trial and error.
MODEL_PARAMETER_APPROACH_TYPE_REINFORCED_LEARNING = 2;
// Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques.
MODEL_PARAMETER_APPROACH_TYPE_SEMI_SUPERVISED = 3;
// Self-supervised machine learning involves training models to predict parts of the input data from other parts of the same data, without requiring external labels, enabling learning from large amounts of unlabeled data.
MODEL_PARAMETER_APPROACH_TYPE_SELF_SUPERVISED = 4;
}

Expand Down
9 changes: 8 additions & 1 deletion schema/bom-1.6.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -3074,7 +3074,14 @@
"reinforcement-learning",
"semi-supervised",
"self-supervised"
]
],
"meta:enum": {
"supervised": "Supervised machine learning involves training an algorithm on labeled data to predict or classify new data based on the patterns learned from the labeled examples.",
"unsupervised": "Unsupervised machine learning involves training algorithms on unlabeled data to discover patterns, structures, or relationships without explicit guidance, allowing the model to identify inherent structures or clusters within the data.",
"reinforcement-learning": "Reinforcement learning is a type of machine learning where an agent learns to make decisions by interacting with an environment to maximize cumulative rewards, through trial and error.",
"semi-supervised": "Semi-supervised machine learning utilizes a combination of labeled and unlabeled data during training to improve model performance, leveraging the benefits of both supervised and unsupervised learning techniques.",
"self-supervised": "Self-supervised machine learning involves training models to predict parts of the input data from other parts of the same data, without requiring external labels, enabling learning from large amounts of unlabeled data."
}
}
}
},
Expand Down
31 changes: 26 additions & 5 deletions schema/bom-1.6.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -3241,27 +3241,48 @@ limitations under the License.
<xs:restriction base="xs:string">
<xs:enumeration value="supervised">
<xs:annotation>
<xs:documentation>TODO</xs:documentation>
<xs:documentation>
Supervised machine learning involves training an algorithm on labeled
data to predict or classify new data based on the patterns learned from
the labeled examples.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="unsupervised">
<xs:annotation>
<xs:documentation>TODO</xs:documentation>
<xs:documentation>
Unsupervised machine learning involves training algorithms on unlabeled
data to discover patterns, structures, or relationships without explicit
guidance, allowing the model to identify inherent structures or clusters
within the data.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="reinforcement-learning">
<xs:annotation>
<xs:documentation>TODO</xs:documentation>
<xs:documentation>
Reinforcement learning is a type of machine learning where an agent learns
to make decisions by interacting with an environment to maximize cumulative
rewards, through trial and error.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="semi-supervised">
<xs:annotation>
<xs:documentation>TODO</xs:documentation>
<xs:documentation>
Semi-supervised machine learning utilizes a combination of labeled and
unlabeled data during training to improve model performance, leveraging
the benefits of both supervised and unsupervised learning techniques.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="self-supervised">
<xs:annotation>
<xs:documentation>TODO</xs:documentation>
<xs:documentation>
Self-supervised machine learning involves training models to predict parts
of the input data from other parts of the same data, without requiring
external labels, enabling learning from large amounts of unlabeled data.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
Expand Down

0 comments on commit 7fb317c

Please sign in to comment.