Documentation: Which recommenders can be exported to Core ML? - Githubissues

apple / turicreate

Turi Create simplifies the development of custom machine learning models.

BSD 3-Clause "New" or "Revised" License

11.18k stars 1.13k forks source link

Documentation: Which recommenders can be exported to Core ML? #1267

Open afranklin opened 5 years ago

afranklin commented 5 years ago

It's not clear which types of recommenders can be exported to Core ML.

We should clearly list which model types can be exported in the recommender export docs (https://apple.github.io/turicreate/docs/userguide/recommender/coreml-deployment.html)
We should also show sample code to force a recommender model that can be exported to Core ML.
We also shouldn't show .export_coreml() in the API docs for unsupported recommenders (e.g. https://apple.github.io/turicreate/docs/api/generated/turicreate.recommender.ranking_factorization_recommender.RankingFactorizationRecommender.export_coreml.html#turicreate.recommender.ranking_factorization_recommender.RankingFactorizationRecommender.export_coreml)

houtzager commented 5 years ago

I agree,

Just ran into the issue myself where I was trying to export a factorization_recommender model to Core ML. It should definitely be stated in the documentation that JUST the item_similarity recommender model can currently be exported. Listing these other recommenders in the documentation, whilst they cannot be exported to CoreML which as far as I know is the main purpose of TuriCreate, is misleading.