Function getMlExperimentModels

  • List models

    Parameters

    • experimentId: string

      ID of the experiment

    • query: { filter?: string; limit?: number; offset?: number; sort?: EnumSortModels }

      an object with query parameters

      • Optionalfilter?: string

        Model fields you can filter by:

        • experimentVersionId UUID string - Find by experiment version ID

        • batchNum UUID string - Search by batch number

        • isHpo boolean - Is hyperparameter optimization used?

        • isMetrics boolean - Are metrics for regression, binary, or multiclass are used?

        • id UUID string - Find by model ID

        • algorithm enum string - Find by algorithm

          • Valid algorithms: catboost_classifier, catboost_regression, elasticnet_regression, gaussian_nb, kneighbors_classifier, lasso_regression, lasso, lgbm_classifier, lgbm_regression, linear_regression, logistic_regression, random_forest_classifier, random_forest_regression, sgd_regression, xgb_classifier, xgb_regression

        • status enum string - find by status

          • Valid statuses: pending, training_requested, training_done, ready, error

        • hasDeployment boolean - Models that are part of a deployment

        • nameContains string - Models with name includes this case-insensitive string

        • exactName string - Models with exact name. Model names may not be unique

        • samplingRatio number - Find models by sampling ratio

        • modelState enum string - State by which to find models

          • Valid states: pending, enabled, disabled, inactive
      • Optionallimit?: number

        Number of results per page. Default is 32.

      • Optionaloffset?: number

        Number of rows to skip before getting page[size]

      • Optionalsort?: EnumSortModels

        Field(s) by which to sort response

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetMlExperimentModelsHttpResponse>

    GetMlExperimentModelsHttpError