Reference¶

Information-oriented description of what Yohou-MLflow provides: the API, its behaviour, and its release history. Reference material is for looking things up, not for learning. It describes the machinery and stays out of your way.

• API Reference: Complete API reference for all Yohou-MLflow classes and functions. Use the search box to filter, or click any name to see full documentation.
• Saved Model Format: Description of a model directory written by save_model or log_model, and of the checks load_model and check_compatibility apply to it. Format version 1.0 (yohou_mlflow.FORMAT_VERSION).
• pyfunc Contract: Description of the python_function flavour of a yohou model: how it loads, what predict accepts, and what it returns.
• Changelog: Release history for every published version, newest first.
• Citation: How to cite Yohou-MLflow, in plain text and in BibTeX.

For the reasoning behind the design, see Explanation.