READMEshould be the entrypoint for developers. Keeping in line with the considerations above, the
READMEshould very quickly discuss how the predictor is used, with code snippets.
Predictwith one or more features.
MLAsyncPredictor. This is critical because developers might need to run predictions asynchronously to preserve their app's frame rate. The implication of this requirement is that the predictor's
Predictmethod must not use any Unity API's which cannot be used from background threads.
MLModelitself. So if the predictor takes too much more time, developers might notice this discrepancy and raise issues with your predictor, leaving it with negative reviews.