diff --git a/spacy/cli/init_config.py b/spacy/cli/init_config.py index 81ac6c9fc..90b92787d 100644 --- a/spacy/cli/init_config.py +++ b/spacy/cli/init_config.py @@ -30,7 +30,7 @@ def init_config_cli( lang: Optional[str] = Opt("en", "--lang", "-l", help="Two-letter code of the language to use"), pipeline: Optional[str] = Opt("tagger,parser,ner", "--pipeline", "-p", help="Comma-separated names of trainable pipeline components to include (without 'tok2vec' or 'transformer')"), optimize: Optimizations = Opt(Optimizations.efficiency.value, "--optimize", "-o", help="Whether to optimize for efficiency (faster inference, smaller model, lower memory consumption) or higher accuracy (potentially larger and slower model). This will impact the choice of architecture, pretrained weights and related hyperparameters."), - cpu: bool = Opt(False, "--cpu", "-C", help="Whether the model needs to run on CPU. This will impact the choice of architecture, pretrained weights and related hyperparameters."), + gpu: bool = Opt(False, "--gpu", "-G", help="Whether the model can run on GPU. This will impact the choice of architecture, pretrained weights and related hyperparameters."), pretraining: bool = Opt(False, "--pretraining", "-pt", help="Include config for pretraining (with 'spacy pretrain')"), # fmt: on ): @@ -50,7 +50,7 @@ def init_config_cli( lang=lang, pipeline=pipeline, optimize=optimize, - cpu=cpu, + gpu=gpu, pretraining=pretraining, silent=is_stdout, ) @@ -124,7 +124,7 @@ def init_config( lang: str, pipeline: List[str], optimize: str, - cpu: bool, + gpu: bool, pretraining: bool = False, silent: bool = True, ) -> Config: @@ -138,7 +138,7 @@ def init_config( "lang": lang, "components": pipeline, "optimize": optimize, - "hardware": "cpu" if cpu else "gpu", + "hardware": "gpu" if gpu else "cpu", "transformer_data": reco["transformer"], "word_vectors": reco["word_vectors"], "has_letters": reco["has_letters"], diff --git a/spacy/tests/test_cli.py b/spacy/tests/test_cli.py index 06c7a3a90..745e1ac23 100644 --- a/spacy/tests/test_cli.py +++ b/spacy/tests/test_cli.py @@ -368,7 +368,7 @@ def test_parse_cli_overrides(): @pytest.mark.parametrize("optimize", ["efficiency", "accuracy"]) def test_init_config(lang, pipeline, optimize): # TODO: add more tests and also check for GPU with transformers - config = init_config(lang=lang, pipeline=pipeline, optimize=optimize, cpu=True) + config = init_config(lang=lang, pipeline=pipeline, optimize=optimize, gpu=False) assert isinstance(config, Config) diff --git a/website/docs/api/cli.md b/website/docs/api/cli.md index 94d459828..46e81f33f 100644 --- a/website/docs/api/cli.md +++ b/website/docs/api/cli.md @@ -121,7 +121,7 @@ customize those settings in your config file later. > ``` ```cli -$ python -m spacy init config [output_file] [--lang] [--pipeline] [--optimize] [--cpu] [--pretraining] +$ python -m spacy init config [output_file] [--lang] [--pipeline] [--optimize] [--gpu] [--pretraining] ``` | Name | Description | @@ -130,7 +130,7 @@ $ python -m spacy init config [output_file] [--lang] [--pipeline] [--optimize] [ | `--lang`, `-l` | Optional code of the [language](/usage/models#languages) to use. Defaults to `"en"`. ~~str (option)~~ | | `--pipeline`, `-p` | Comma-separated list of trainable [pipeline components](/usage/processing-pipelines#built-in) to include. Defaults to `"tagger,parser,ner"`. ~~str (option)~~ | | `--optimize`, `-o` | `"efficiency"` or `"accuracy"`. Whether to optimize for efficiency (faster inference, smaller model, lower memory consumption) or higher accuracy (potentially larger and slower model). This will impact the choice of architecture, pretrained weights and related hyperparameters. Defaults to `"efficiency"`. ~~str (option)~~ | -| `--cpu`, `-C` | Whether the model needs to run on CPU. This will impact the choice of architecture, pretrained weights and related hyperparameters. ~~bool (flag)~~ | +| `--gpu`, `-G` | Whether the model can run on GPU. This will impact the choice of architecture, pretrained weights and related hyperparameters. ~~bool (flag)~~ | | `--pretraining`, `-pt` | Include config for pretraining (with [`spacy pretrain`](/api/cli#pretrain)). Defaults to `False`. ~~bool (flag)~~ | | `--help`, `-h` | Show help message and available arguments. ~~bool (flag)~~ | | **CREATES** | The config file for training. |