aws / aws/sagemaker-python-sdk

Incorrect type annotation of hyperparameter_ranges argument of HyperparameterTuner constructor

Offen
#5,243 0 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
component: training type: bug
Vorherrschende Sprache
Python
Sterne
2.3k
Forks
1.3k
Ø Merge
1 T. 22 Std.
Gemergte PRs (30 T.)
35

Beschreibung

**Describe the bug**
hyperparameter_ranges argument of HyperparameterTuner constructor is annotated as Dict[str, ParameterRange], however HyperparameterTuner works correctly with PipelineVariable as key of Dict (hyperparam name), so the correct type annotation could be: Dict[str, ParameterRange]

**To reproduce**
That code works properly:
```python
from sagemaker.pytorch import PyTorch
from sagemaker.tuner import HyperparameterTuner, CategoricalParameter
from sagemaker.workflow.parameters import ParameterString
from sagemaker.workflow.steps import TuningStep
from sagemaker.workflow.pipeline import Pipeline
from sagemaker.workflow.pipeline_context import (
PipelineSession
)

if __name__ == "__main__":
pipeline_session = PipelineSession()

estimator = PyTorch(
sagemaker_session=pipeline_session,
instance_type='ml.m5.large',
instance_count=1,
framework_version="2.3",
py_version="py311",
source_dir='source',
entry_point='main.py',
metric_definitions=[
{'Name': 'valid:loss', 'Regex': 'valid_loss=([0-9]+\\.?[0-9]*)'}
]
)

hparam_name = ParameterString("HParamName", default_value='hparam')

tuner = HyperparameterTuner(
estimator=estimator,
objective_metric_name='valid:loss',
objective_type='Minimize',
hyperparameter_ranges={
hparam_name: CategoricalParameter(
[1, 2]
)
},
max_jobs=2,
max_parallel_jobs=1,
base_tuning_job_name='test-tuning',
strategy='Grid',
metric_definitions=estimator.metric_definitions,
)

tuning_step = TuningStep(
name="Tuning",
step_args=tuner.fit(),
)

pipeline = Pipeline(
name="TestTuningPipeline",
parameters=[hparam_name],
steps=[tuning_step],
sagemaker_session=pipeline_session
)

pipeline.upsert()
execution = pipeline.start(
execution_display_name="TuningTest",
)
print(execution)
```
But the type annotation of hyperparameter_ranges is incorrect.
`mypy main.py --follow-untyped-imports` reports:
```
test.py:35: error: Dict entry 0 has incompatible type "ParameterString": "CategoricalParameter"; expected "str": "ParameterRange" [dict-item]
```

**Expected behavior**
Correct type annotation of constructor arguments of HyperparameterTuner

**Screenshots or logs**
-

**System information**
A description of your system. Please provide:
- **SageMaker Python SDK version**: 2.239.3
- **Framework name (eg. PyTorch) or algorithm (eg. KMeans)**: iirelevant
- **Framework version**: iirelevant
- **Python version**: 3.12
- **CPU or GPU**: iirelevant
- **Custom Docker image (Y/N)**: iirelevant

**Additional context**
-

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie beim Konstruktor von HyperparameterTuner und untersuchen Sie die Annotation von hyperparameter_ranges. Verwenden Sie das mitgelieferte Beispiel, um den akzeptierten Schlüsseltyp nachzuverfolgen. Führen Sie mypy main.py --follow-untyped-imports aus und bestätigen Sie, dass der gemeldete dict-item-Fehler verschwunden ist, während der Konstruktor weiterhin korrekt typisiert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
aws, python
Bereich
machine-learning
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
52/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.