Skip to content

Commit

Permalink
Fix typos (#248)
Browse files Browse the repository at this point in the history
  • Loading branch information
kianmeng committed Apr 22, 2022
1 parent 6ac93d7 commit 603ed97
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion spock/addons/tune/tuner.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def __init__(
)

def sample(self):
"""Public interface to underlying library sepcific sample that returns a single sample/draw from the
"""Public interface to underlying library specific sample that returns a single sample/draw from the
hyper-parameter sets (e.g. ranges, choices) and combines them with the fixed parameters into a single Spockspace
Returns:
Expand Down
2 changes: 1 addition & 1 deletion tests/conf/toml/test.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ high_config = 'SingleNestedConfig'
[FirstDoubleNestedConfig]
h_factor = 0.99
v_factor = 0.90
# Overrride general definition
# Override general definition
[TypeConfig]
float_p = 12.0
call_me = 'tests.base.attr_configs_test.foo'
Expand Down
2 changes: 1 addition & 1 deletion tests/conf/toml/test_include.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# additional conf file to test inheritance
# include another file
config = ["test.toml"]
# override a paramter
# override a parameter
int_p = 9
2 changes: 1 addition & 1 deletion website/docs/addons/tuner/Ax.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ fixed_params = attrs_obj.generate()

The `sample()` call is the crux of `spock` hyper-parameter tuning support. It draws a hyper-parameter sample from the
underlying backend sampler and combines it with fixed parameters and returns a single `Spockspace` with all
useable parameters (defined with dot notation). For Ax -- Under the hood `spock` uses the Service API (with
usable parameters (defined with dot notation). For Ax -- Under the hood `spock` uses the Service API (with
an `AxClient`) -- thus it handles the underlying call to get the next trial. The `spock` builder object has a
`@property` called `tuner_status` that returns any necessary backend objects in a dictionary that the user needs to
interface with. In the case of Ax, this contains both the `AxClient` and `trial_index` (as dictionary keys). We use
Expand Down
2 changes: 1 addition & 1 deletion website/docs/addons/tuner/Optuna.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ fixed_params = attrs_obj.generate()

The `sample()` call is the crux of `spock` hyper-parameter tuning support. It draws a hyper-parameter sample from the
underlying backend sampler and combines it with fixed parameters and returns a single `Spockspace` with all
useable parameters (defined with dot notation). For Optuna -- Under the hood `spock` uses the define-and-run Optuna
usable parameters (defined with dot notation). For Optuna -- Under the hood `spock` uses the define-and-run Optuna
interface -- thus it handles the underlying 'ask' call. The `spock` builder object has a `@property` called
`tuner_status` that returns any necessary backend objects in a dictionary that the user needs to interface with. In the
case of Optuna, this contains both the Optuna `study` and `trial` (as dictionary keys). We use the return of
Expand Down
2 changes: 1 addition & 1 deletion website/docs/addons/tuner/Saving.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Would result in the following YAML file:

If we want to save each individual hyper-parameter sample we again use the `save()` call with the addition of the
`add_tuner_sample=True` keyword arg and chain it before the`sample()` call. The order might be slightly confusing
but this is to allow all methods to return the builder object except for hte `sample()` and `generate()` calls
but this is to allow all methods to return the builder object except for the `sample()` and `generate()` calls
which returns a `Spockspace`. The saver will append `hp.sample.[0-9+]` to the filename to identify each sample
configuration.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/advanced_features/Command-Line-Overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ valid command-line arguments:
```

None of these command-line arguments are required (i.e. sets `required=False` within the argparser), but a value must
be set via one of the three core mechanisms: (1) a default value (set withing the `@spock` decorated class), (2) the
be set via one of the three core mechanisms: (1) a default value (set within the `@spock` decorated class), (2) the
configuration file (passed in with the `--config` argument), or (3) the command-line argument (this takes precedence
over all other methods).

Expand Down

0 comments on commit 603ed97

Please sign in to comment.