Skip to content

Wrong Enum Values for Transformer strategy #1333

@jaredleekatzman

Description

@jaredleekatzman

What did you find confusing? Please describe.
When trying to build a transformer from a TensorFlowModel, e.g.

transformer = model.transformer(
    instance_count=1, instance_type='ml.m5.large', assemble_with='Line',
    accept='application/json', output_path=output_uri, strategy='SingleRecord'
)

The doc string gave wrong information for the parameter strategy. The Doc says the values must be of either [MULTI_RECORD, SINGLE_RECORD]. I tried them but then the API throws an error.

When you look at the Transformer API doc string the value of the strings mus be of either [MultiRecord, SingleRecord], and there doesn't seem to be a value translation.

Describe how documentation can be improved
The right values of the strategy parameter should be mentioned correctly across the sagemaker-python-sdk documentation. There seems to be 7-8 occurrses across the GitHub Repo link:

  • entities.py
  • pipeline.py
  • algorithm.py
  • model.py
  • tensorflow/estimator.py
  • airflow.py
  • estimator.py
  • session.py

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions