aws / sagemaker-python-sdk

A library for training and deploying machine learning models on Amazon SageMaker
https://sagemaker.readthedocs.io/
Apache License 2.0
2.09k stars 1.14k forks source link

Environment variables limited to 256 characters #2932

Open jmahlik opened 2 years ago

jmahlik commented 2 years ago

Describe the bug Currently, the value length constraints for environment variables are quite limited in CreateProcessingJob and CreateTrainingJob.

This causes issues when passing urls or other long strings via the environment parameter, as they often exceed the limit. I am not aware of an alternative to pass items that shouldn't be written to files to a job at runtime. Storing some info on s3 and treating it as an input cannot be used as a workaround, as some variables should not be shared with everyone who has access to the s3 bucket nor stored long term. It's also inconvenient to write a notebook/user's env vars to s3, read them in, set them as env vars etc.

It looks like it would be possible to have an api call accept keys that are over 256 characters in length. Example https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html#sagemaker-CreateTrainingJob-request-HyperParameters accepts 2500 characters.

To reproduce Pass a string over the char limit similar to below.

estimator = sagemaker.estimator.Estimator(
    image,
    role,
    environment={"LONG_STRING": "".join(("0" for _ in range(513)))},
    instance_count=1,
    instance_type=instance_type,
)

script_processor = sagemaker.processing.ScriptProcessor(
    command=["my", "command"],
    env={"LONG_STRING": "".join(("0" for _ in range(257)))},
    image_uri=image,
    role=role,
    instance_count=1,
    instance_type=instance_type,
)

Expected behavior Ability to pass longer environment variables to jobs.

Screenshots or logs

botocore.exceptions.ClientError: An error occurred (ValidationException) when calling the CreateProcessingJob operation: 1 validation error detected: Value '<CENSORED>' at 'environment' failed to satisfy constraint: Map value must satisfy constraint: [Member must have length less than or equal to 256, Member must have length greater than or equal to 0, Member must satisfy regular expression pattern: [\S\s]*]

System information A description of your system. Please provide:

Additional context I suspect others may be facing the same issue as there is mention of passing custom urls for pip configurations.

https://github.com/aws/sagemaker-python-sdk/issues/2207#issuecomment-810096332

fxmarty commented 2 years ago

It is not clear why there is such a limit.

dyihoon90 commented 2 years ago

Yeah this limit des not work very well with their other services.

These pipelines are regularly added to part of step functions.

I am trying to pass in the Step Function Task Token (which goes up to 1024 length) to our post-processing step of our Sagemaker transform pipeline and hitting this wall.

mesquita commented 1 year ago

Was anyone able to get past this problem?

jmahlik commented 1 year ago

Was anyone able to get past this problem?

No, it's enforced by the api. Writing files to s3 or using secrets manager are about the only solutions.