Save the model to a file. Parameters ---------- fname : string Output file name. format : string Possible values: * 'cbm' for catboost binary format, * 'coreml' to export into Apple CoreML format
(self, fname, format="cbm", export_parameters=None, pool=None)
| 3700 | self._base_drop_unused_features() |
| 3701 | |
| 3702 | def save_model(self, fname, format="cbm", export_parameters=None, pool=None): |
| 3703 | """ |
| 3704 | Save the model to a file. |
| 3705 | |
| 3706 | Parameters |
| 3707 | ---------- |
| 3708 | fname : string |
| 3709 | Output file name. |
| 3710 | format : string |
| 3711 | Possible values: |
| 3712 | * 'cbm' for catboost binary format, |
| 3713 | * 'coreml' to export into Apple CoreML format |
| 3714 | * 'onnx' to export into ONNX-ML format |
| 3715 | * 'pmml' to export into PMML format |
| 3716 | * 'cpp' to export as C++ code |
| 3717 | * 'python' to export as Python code. |
| 3718 | export_parameters : dict |
| 3719 | Parameters for CoreML export: |
| 3720 | * prediction_type : string - either 'probability' or 'raw' |
| 3721 | * coreml_description : string |
| 3722 | * coreml_model_version : string |
| 3723 | * coreml_model_author : string |
| 3724 | * coreml_model_license: string |
| 3725 | Parameters for PMML export: |
| 3726 | * pmml_copyright : string |
| 3727 | * pmml_description : string |
| 3728 | * pmml_model_version : string |
| 3729 | pool : catboost.Pool or list or numpy.ndarray or pandas.DataFrame or pandas.Series or polars.DataFrame or catboost.FeaturesData |
| 3730 | Training pool. |
| 3731 | """ |
| 3732 | if not self.is_fitted(): |
| 3733 | raise CatBoostError("There is no trained model to use save_model(). Use fit() to train model. Then use this method.") |
| 3734 | if not isinstance(fname, PATH_TYPES): |
| 3735 | raise CatBoostError("Invalid fname type={}: must be str or os.PathLike.".format(type(fname))) |
| 3736 | if pool is not None and not isinstance(pool, Pool): |
| 3737 | pool = Pool( |
| 3738 | data=pool, |
| 3739 | cat_features=self._get_cat_feature_indices() if not isinstance(pool, FeaturesData) else None, |
| 3740 | text_features=self._get_text_feature_indices() if not isinstance(pool, FeaturesData) else None, |
| 3741 | embedding_features=self._get_embedding_feature_indices() if not isinstance(pool, FeaturesData) else None |
| 3742 | ) |
| 3743 | self._save_model(fname, format, export_parameters, pool) |
| 3744 | |
| 3745 | def load_model(self, fname=None, format='cbm', stream=None, blob=None): |
| 3746 | """ |