matlantis_features.utils.calculators.pfp_api_calculator.pfp_estimator_fn(*, max_retries: int = 10, model_version: str = ‘v7.0.0’, address: str = ‘localhost:5000’, priority: int = 100, calc_mode: Optional[EstimatorCalcMode] = None, method_type: Optional[EstimatorMethodType] = None) → Callable[[], Estimator]#

An estimator function for a PFP estimator.

For more information about the estimator function,
please read our guidebook(en)
or guidebook(ja).

Parameters

  • max_retries (int, optional) – Maximum number of retries when pfp-api-client fails to
    create an estimator. Defaults to 10.

  • model_version (str, optional) – The model version to be set.

  • address (str, optional) – The address of PFP API server.

  • priority (int, optional) – An integer (1 to 100) that determines how to prioritize requests
    when there is a lack of Token Availability. Defaults to 100.

  • secure (bool, optional) – The flag to control if it uses SSL.

  • ca_cert_path (str or None, optional) – The path to certificate file

  • calc_mode (EstimatorCalcMode or None, optional) – The calculation mode.

  • method_type (EstimatorMethodType or None, optional) – The inference method type to be set.

Returns

callable object that returns an estimator.

Return type

EstimatorFnType