From 603ed97693fa0ee50b24cb03bb7b9ab427bc7d22 Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Sat, 23 Apr 2022 00:05:01 +0800 Subject: [PATCH] Fix typos (#248) --- spock/addons/tune/tuner.py | 2 +- tests/conf/toml/test.toml | 2 +- tests/conf/toml/test_include.toml | 2 +- website/docs/addons/tuner/Ax.md | 2 +- website/docs/addons/tuner/Optuna.md | 2 +- website/docs/addons/tuner/Saving.md | 2 +- website/docs/advanced_features/Command-Line-Overrides.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/spock/addons/tune/tuner.py b/spock/addons/tune/tuner.py index 9d2e11d8..f12dc102 100644 --- a/spock/addons/tune/tuner.py +++ b/spock/addons/tune/tuner.py @@ -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: diff --git a/tests/conf/toml/test.toml b/tests/conf/toml/test.toml index bc54482a..d60fcb6e 100644 --- a/tests/conf/toml/test.toml +++ b/tests/conf/toml/test.toml @@ -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' diff --git a/tests/conf/toml/test_include.toml b/tests/conf/toml/test_include.toml index 8e2af2c2..41f9dcbc 100644 --- a/tests/conf/toml/test_include.toml +++ b/tests/conf/toml/test_include.toml @@ -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 \ No newline at end of file diff --git a/website/docs/addons/tuner/Ax.md b/website/docs/addons/tuner/Ax.md index 83a13604..f8dd91d9 100644 --- a/website/docs/addons/tuner/Ax.md +++ b/website/docs/addons/tuner/Ax.md @@ -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 diff --git a/website/docs/addons/tuner/Optuna.md b/website/docs/addons/tuner/Optuna.md index 415184bf..b42ebc1c 100644 --- a/website/docs/addons/tuner/Optuna.md +++ b/website/docs/addons/tuner/Optuna.md @@ -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 diff --git a/website/docs/addons/tuner/Saving.md b/website/docs/addons/tuner/Saving.md index 08cc78d9..397298fb 100644 --- a/website/docs/addons/tuner/Saving.md +++ b/website/docs/addons/tuner/Saving.md @@ -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. diff --git a/website/docs/advanced_features/Command-Line-Overrides.md b/website/docs/advanced_features/Command-Line-Overrides.md index 214f5dbe..933c2318 100644 --- a/website/docs/advanced_features/Command-Line-Overrides.md +++ b/website/docs/advanced_features/Command-Line-Overrides.md @@ -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).