Skip to content

Commit 600fda7

Browse files
tonybove-appleabove3
andauthored
Mlmodel Docs - Update Model.proto and Model.rst (#2101)
* Mlmodel Docs - Update Model.proto and Model.rst * Edits for Mlmodel Docs - Update Model.proto and Model.rst --------- Co-authored-by: above3 <[email protected]>
1 parent ba399c8 commit 600fda7

File tree

3 files changed

+35
-33
lines changed

3 files changed

+35
-33
lines changed

mlmodel/docs/Format/Model.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ A Core ML model consists of a specification version and a model description,
55
and can be any one of the following types:
66

77
Neural Networks
8+
- ``MILSpec.Program``
89
- ``NeuralNetwork``
910

1011
Regressors

mlmodel/docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. Core ML Format Reference documentation master file, created by
2-
sphinx-quickstart on Mon Jun 28 11:26:31 2021.
2+
sphinx-quickstart on Mon Jun 28 11:26:31 2021. Edited Jan. 3 2024.
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
@@ -8,7 +8,7 @@ Core ML Model Format Specification
88
##################################
99

1010
This document contains the protobuf message definitions
11-
that comprise the Core ML model document (``.mlmodel``) format. The top-level
11+
that comprise the Core ML model format. The top-level
1212
message is `Model`, which is defined in :file:`Model.proto`.
1313
Other message types describe data structures, feature types,
1414
feature engineering model types, and predictive model types.

mlmodel/format/Model.proto

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
* and can be any one of the following types:
1010
*
1111
* Neural Networks
12-
* - `NeuralNetwork`
12+
* - ``MILSpec.Program``
13+
* - ``NeuralNetwork``
1314
*
1415
* Regressors
1516
* - ``GLMRegressor``
@@ -19,42 +20,42 @@
1920
* - ``BayesianProbitRegressor``
2021
*
2122
* Classifiers
22-
* - `NeuralNetworkClassifier`
23-
* - `TreeEnsembleClassifier`
24-
* - `GLMClassifier`
25-
* - `SupportVectorClassifier`
26-
* - `KNearestNeighborsClassifier`
23+
* - ``NeuralNetworkClassifier``
24+
* - ``TreeEnsembleClassifier``
25+
* - ``GLMClassifier``
26+
* - ``SupportVectorClassifier``
27+
* - ``KNearestNeighborsClassifier``
2728
*
2829
* Other models
29-
* - `CustomModel`
30-
* - `TextClassifier`
31-
* - `WordTagger`
32-
* - `Gazetteer`
33-
* - `WordEmbedding`
34-
* - `VisionFeaturePrint`
35-
* - `LinkedModel`
36-
* - `SoundAnalysisPreprocessing`
37-
* - `ItemSimilarityRecommender`
38-
* - `ClassConfidenceThresholding`
30+
* - ``CustomModel``
31+
* - ``TextClassifier``
32+
* - ``WordTagger``
33+
* - ``Gazetteer``
34+
* - ``WordEmbedding``
35+
* - ``VisionFeaturePrint``
36+
* - ``LinkedModel``
37+
* - ``SoundAnalysisPreprocessing``
38+
* - ``ItemSimilarityRecommender``
39+
* - ``ClassConfidenceThresholding``
3940
*
4041
* Feature Engineering
41-
* - `Imputer`
42-
* - `Scaler`
43-
* - `Normalizer`
44-
* - `OneHotEncoder`
45-
* - `CategoricalMapping`
46-
* - `FeatureVectorizer`
47-
* - `DictVectorizer`
48-
* - `ArrayFeatureExtractor`
49-
* - `NonMaximumSuppression`
42+
* - ``Imputer``
43+
* - ``Scaler``
44+
* - ``Normalizer``
45+
* - ``OneHotEncoder``
46+
* - ``CategoricalMapping``
47+
* - ``FeatureVectorizer``
48+
* - ``DictVectorizer``
49+
* - ``ArrayFeatureExtractor``
50+
* - ``NonMaximumSuppression``
5051
*
5152
* Pipelines
52-
* - `PipelineClassifier`
53-
* - `PipelineRegressor`
54-
* - `Pipeline`
53+
* - ``PipelineClassifier``
54+
* - ``PipelineRegressor``
55+
* - ``Pipeline``
5556
*
5657
* Simple Mathematical Functions
57-
* - `Identity`
58+
* - ``Identity``
5859
*/
5960

6061
syntax = "proto3";
@@ -95,7 +96,7 @@ import public "ClassConfidenceThresholding.proto";
9596
package CoreML.Specification;
9697

9798
/*
98-
* A pipeline consisting of one or more models.
99+
* A pipeline consists of one or more models.
99100
*/
100101
message Pipeline {
101102
repeated Model models = 1;
@@ -121,7 +122,7 @@ message PipelineRegressor {
121122
}
122123

123124
/*
124-
* A feature description,
125+
* A feature description
125126
* consisting of a name, short description, and type.
126127
*/
127128
message FeatureDescription {

0 commit comments

Comments
 (0)