Issue on page /tune/tutorials/tune-resources.html

[davidegraff]

The problem
The code snippets on this page are generally of the form:

# If you have 8 GPUs, this will run 8 trials at once.
tuner = tune.Tuner(tune.with_resources(trainable, {"gpu": 1}, tune_config=tune.TuneConfig(num_samples=10))
results = tuner.fit()

This code a missing a closing parenthesis and will result in a SyntaxError if a user tries to run it. Moreover, it causes confusion with respect to where a TuneConfig should be placed: inside tune.with_resources or tune.Tuner.__init__?

Suggested Fixes

1. add the closing parenthesis:

# If you have 8 GPUs, this will run 8 trials at once.
tuner = tune.Tuner(tune.with_resources(trainable, {"gpu": 1}), tune_config=tune.TuneConfig(num_samples=10))
results = tuner.fit()

# If you have 4 CPUs on your machine and 1 GPU, this will run 1 trial at a time.
tuner = tune.Tuner(tune.with_resources(trainable, {"cpu": 2, "gpu": 1}), tune_config=tune.TuneConfig(num_samples=10))
results = tuner.fit()

2. indent continued code blocks to increase legibility:

# If you have 8 GPUs, this will run 8 trials at once.
tuner = tune.Tuner(
    tune.with_resources(trainable, {"gpu": 1}),
    tune_config=tune.TuneConfig(num_samples=10)
)
results = tuner.fit())

3. assign variables outside of function calls to emphasize what the in-line function calls represent:

trainable_with_resources = tune.with_resources(trainable, {"gpu": 1})    # or some other name
tuner = tune.Tuner(trainable_with_resources, tune_config=tune.TuneConfig(num_samples=10))
results = tuner.fit())

[matthewdeng]

Thanks for flagging this! @justinvyu can you take this one?