TabularCloudPredictor.predict_proba#

TabularCloudPredictor.predict_proba(test_data: Union[str, DataFrame], test_data_image_column: Optional[str] = None, include_predict: bool = True, predictor_path: Optional[str] = None, framework_version: str = 'latest', job_name: Optional[str] = None, instance_type: str = 'ml.m5.2xlarge', instance_count: int = 1, custom_image_uri: Optional[str] = None, wait: bool = True, backend_kwargs: Optional[Dict] = None) → Optional[Union[Tuple[Series, Union[DataFrame, Series]], DataFrame, Series]]#

批量推理 当延迟不是主要考虑因素时，批量转换功能可能更简单、更具可扩展性且更合适。如果需要最小化延迟，请改用 predict_real_time()。

参数

  • test_data (Union(str, pandas.DataFrame)) – 用于推理的测试数据。可以是 pandas.DataFrame，或本地 csv 文件路径。

  • test_data_image_column (str, 默认值 = None) – 如果测试数据包含图像模态，则必须指定对应图像路径的列名。该路径必须是绝对路径（abspath）。

  • include_predict (bool, 默认值 = True) – 是否在返回预测概率结果的同时包含预测结果。由于批量推理涉及明显的开销，此标志可以节省您调用两次 API 以获取预测和概率的时间。

  • predictor_path (str) – 您想要用于预测的预测器 tarball 文件路径。路径可以是本地路径或 S3 位置。如果为 None，将使用最近一次通过 fit() 训练的预测器。

  • framework_version (str, 默认值 = latest) – AutoGluon 的推理容器版本。如果为 latest，将使用最新的可用容器版本。如果提供了特定版本，将使用该版本。如果设置了 custom_image_uri，则此参数将被忽略。

  • job_name (str, 默认值 = None) – 启动的训练作业名称。如果为 None，CloudPredictor 将创建一个以 ag-cloudpredictor 为前缀的名称。

  • instance_count (int, 默认值 = 1) – 用于执行批量转换的实例数量。

  • instance_type (str, 默认值 = 'ml.m5.2xlarge') – 用于批量转换的实例类型。

  • wait (bool, 默认值 = True) – 是否等待批量转换完成。需要注意的是，此函数不会立即返回，因为在转换之前需要一些准备工作。

  • backend_kwargs (dict, 默认值 = None) –

    传递给底层后端所需的任何额外参数。对于 SageMaker 后端，有效键包括：

    1. download: bool, 默认值 = True

      是否将批量转换结果下载到磁盘并在批量转换完成后加载。如果 wait 为 False，则此项将被忽略。

    2. persist: bool, 默认值 = True

      是否将下载的批量转换结果保留在磁盘上。如果 download 为 False，则此项将被忽略。

    3. save_path: str, 默认值 = None,

      保存下载结果的路径。如果 download 为 False，则此项将被忽略。如果为 None，CloudPredictor 将创建一个路径。如果 persist 为 False，文件将首先下载到此路径，然后被删除。

    4. model_kwargs: dict, 默认值 = dict()

      初始化 Sagemaker Model 所需的任何额外参数。有关所有选项，请参考 https://sagemaker.readthedocs.io/en/stable/api/inference/model.html#model

    5. transformer_kwargs: dict

      传递给 transformer 所需的任何额外参数。有关所有选项，请参考 https://sagemaker.readthedocs.io/en/stable/api/inference/transformer.html#sagemaker.transformer.Transformer。

    6. transform_kwargs

      传递给 transform 所需的任何额外参数。有关所有选项，请参考 https://sagemaker.readthedocs.io/en/stable/api/inference/transformer.html#sagemaker.transformer.Transformer.transform。

返回值

如果 download 为 False，将返回 None；如果 include_predict 为 True，则返回 (None, None)。如果 download 为 True 且 include_predict 为 True，将返回 (prediction, predict_probability)，其中 prediction 是 Pandas.Series，predict_probability 是 Pandas.DataFrame 或 Pandas.Series（当问题是回归时，predict_probability 与 prediction 相同）。

返回类型

Optional[Union[Tuple[pd.Series, Union[pd.DataFrame, pd.Series]], Union[pd.DataFrame, pd.Series]]]