SageMaker / Client / list_model_metadata

list_model_metadata#

SageMaker.Client.list_model_metadata(**kwargs)#

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

Request Syntax

response = client.list_model_metadata(
    SearchExpression={
        'Filters': [
            {
                'Name': 'Domain'|'Framework'|'Task'|'FrameworkVersion',
                'Value': 'string'
            },
        ]
    },
    NextToken='string',
    MaxResults=123
)

Parameters:

SearchExpression (dict) –
One or more filters that searches for the specified resource or resources in a search. All resource objects that satisfy the expression’s condition are included in the search results. Specify the Framework, FrameworkVersion, Domain or Task to filter supported. Filter names and values are case-sensitive.
- Filters (list) –
  
  A list of filter objects.
  - (dict) –
    
    Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).
    - Name (string) – [REQUIRED]
      
      The name of the of the model to filter by.
    - Value (string) – [REQUIRED]
      
      The value to filter the model metadata.
NextToken (string) – If the response to a previous ListModelMetadataResponse request was truncated, the response includes a NextToken. To retrieve the next set of model metadata, use the token in the next request.
MaxResults (integer) – The maximum number of models to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'ModelMetadataSummaries': [
        {
            'Domain': 'string',
            'Framework': 'string',
            'Task': 'string',
            'Model': 'string',
            'FrameworkVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ModelMetadataSummaries (list) –
  
  A structure that holds model metadata.
  - (dict) –
    
    A summary of the model metadata.
    - Domain (string) –
      
      The machine learning domain of the model.
    - Framework (string) –
      
      The machine learning framework of the model.
    - Task (string) –
      
      The machine learning task of the model.
    - Model (string) –
      
      The name of the model.
    - FrameworkVersion (string) –
      
      The framework version of the model.
- NextToken (string) –
  
  A token for getting the next set of recommendations, if there are any.