Skip to content

Commit 117ab55

Browse files
committed
DOC improve example description for ingestion
1 parent 0c5ba65 commit 117ab55

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ public and private test set.
1919
* `ingestion.py`: A script to run the ingestion. The role of this script is
2020
to load the submission code and produce predictions that can be evaluated
2121
with the `scoring_program`.
22-
In our example, the submission define a `train_model` function that is
23-
called with the training data, and returns a model from which we can call
24-
the `predict` method.
25-
The predictions are then stored as a csv file, to be loaded with the
26-
`scoring_program`.
22+
In our example, `the submission.py` define a `get_model` function that
23+
returns a scikit-learn compatible model. This model is then fitted on the
24+
training data calling `fit`, and the `predict` method is used to generate
25+
predictions on the test data. These predictions are stored as a csv file,
26+
to be loaded with the `scoring_program`.
2727
- `scoring_program/`: contains the scoring program that will be run to evaluate
2828
the predictions generated by the ingestion program. It loads the predictions
2929
and the ground truth labels, computes the evaluation metric (accuracy in this

0 commit comments

Comments
 (0)