mirror of
https://github.com/explosion/spaCy.git
synced 2025-08-07 13:44:55 +03:00
Remove spacy ray from cli docs
This commit is contained in:
parent
03eebe9d1c
commit
42c02ae8e0
|
@ -15,7 +15,6 @@ menu:
|
||||||
- ['assemble', 'assemble']
|
- ['assemble', 'assemble']
|
||||||
- ['package', 'package']
|
- ['package', 'package']
|
||||||
- ['project', 'project']
|
- ['project', 'project']
|
||||||
- ['ray', 'ray']
|
|
||||||
- ['huggingface-hub', 'huggingface-hub']
|
- ['huggingface-hub', 'huggingface-hub']
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1503,50 +1502,6 @@ $ python -m spacy project dvc [project_dir] [workflow] [--force] [--verbose] [--
|
||||||
| `--help`, `-h` | Show help message and available arguments. ~~bool (flag)~~ |
|
| `--help`, `-h` | Show help message and available arguments. ~~bool (flag)~~ |
|
||||||
| **CREATES** | A `dvc.yaml` file in the project directory, based on the steps defined in the given workflow. |
|
| **CREATES** | A `dvc.yaml` file in the project directory, based on the steps defined in the given workflow. |
|
||||||
|
|
||||||
## ray {#ray new="3"}
|
|
||||||
|
|
||||||
The `spacy ray` CLI includes commands for parallel and distributed computing via
|
|
||||||
[Ray](https://ray.io).
|
|
||||||
|
|
||||||
<Infobox variant="warning">
|
|
||||||
|
|
||||||
To use this command, you need the
|
|
||||||
[`spacy-ray`](https://github.com/explosion/spacy-ray) package installed.
|
|
||||||
Installing the package will automatically add the `ray` command to the spaCy
|
|
||||||
CLI.
|
|
||||||
|
|
||||||
</Infobox>
|
|
||||||
|
|
||||||
### ray train {#ray-train tag="command"}
|
|
||||||
|
|
||||||
Train a spaCy pipeline using [Ray](https://ray.io) for parallel training. The
|
|
||||||
command works just like [`spacy train`](/api/cli#train). For more details and
|
|
||||||
examples, see the usage guide on
|
|
||||||
[parallel training](/usage/training#parallel-training) and the spaCy project
|
|
||||||
[integration](/usage/projects#ray).
|
|
||||||
|
|
||||||
```cli
|
|
||||||
$ python -m spacy ray train [config_path] [--code] [--output] [--n-workers] [--address] [--gpu-id] [--verbose] [overrides]
|
|
||||||
```
|
|
||||||
|
|
||||||
> #### Example
|
|
||||||
>
|
|
||||||
> ```cli
|
|
||||||
> $ python -m spacy ray train config.cfg --n-workers 2
|
|
||||||
> ```
|
|
||||||
|
|
||||||
| Name | Description |
|
|
||||||
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
||||||
| `config_path` | Path to [training config](/api/data-formats#config) file containing all settings and hyperparameters. ~~Path (positional)~~ |
|
|
||||||
| `--code`, `-c` | Path to Python file with additional code to be imported. Allows [registering custom functions](/usage/training#custom-functions) for new architectures. ~~Optional[Path] \(option)~~ |
|
|
||||||
| `--output`, `-o` | Directory or remote storage URL for saving trained pipeline. The directory will be created if it doesn't exist. ~~Optional[Path] \(option)~~ |
|
|
||||||
| `--n-workers`, `-n` | The number of workers. Defaults to `1`. ~~int (option)~~ |
|
|
||||||
| `--address`, `-a` | Optional address of the Ray cluster. If not set (default), Ray will run locally. ~~Optional[str] \(option)~~ |
|
|
||||||
| `--gpu-id`, `-g` | GPU ID or `-1` for CPU. Defaults to `-1`. ~~int (option)~~ |
|
|
||||||
| `--verbose`, `-V` | Display more information for debugging purposes. ~~bool (flag)~~ |
|
|
||||||
| `--help`, `-h` | Show help message and available arguments. ~~bool (flag)~~ |
|
|
||||||
| overrides | Config parameters to override. Should be options starting with `--` that correspond to the config section and value to override, e.g. `--paths.train ./train.spacy`. ~~Any (option/flag)~~ |
|
|
||||||
|
|
||||||
## huggingface-hub {#huggingface-hub new="3.1"}
|
## huggingface-hub {#huggingface-hub new="3.1"}
|
||||||
|
|
||||||
The `spacy huggingface-cli` CLI includes commands for uploading your trained
|
The `spacy huggingface-cli` CLI includes commands for uploading your trained
|
||||||
|
|
Loading…
Reference in New Issue
Block a user