explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2025-08-05 04:40:20 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add defaults to docs

Browse Source 
Minor fixes
This commit is contained in:
shademe 2022-12-22 17:16:31 +01:00
parent 41ec44d99a
commit 7e793ded5a
No known key found for this signature in database
GPG Key ID: 6FCA9FC635B2A402
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
website/docs/api/top-level.md
View File

@ -513,7 +513,7 @@ a [Weights & Biases](https://www.wandb.com/) dashboard.
Instead of using one of the built-in loggers, you can Instead of using one of the built-in loggers, you can
[implement your own](/usage/training#custom-logging). [implement your own](/usage/training#custom-logging).
#### spacy.ConsoleLogger.v2 {#ConsoleLogger tag="registered function"} #### spacy.ConsoleLogger.v2 {tag="registered function"}
> #### Example config > #### Example config
> >
@ -564,11 +564,11 @@ start decreasing across epochs.
</Accordion> </Accordion>
| Name | Description | | Name | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------- | | ---------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `progress_bar` | Whether the logger should print a progress bar tracking the steps till the next evaluation pass.~~bool~~ | | `progress_bar` | Whether the logger should print a progress bar tracking the steps till the next evaluation pass (default: `False`).~~bool~~ |
| `console_output` | Whether the logger should print the logs in the console. ~~bool~~ | | `console_output` | Whether the logger should print the logs in the console (default: `True`). ~~bool~~ |
| `output_file` | The file to save the training logs to. ~~Optional[Union[str, Path]]~~ | | `output_file` | The file to save the training logs to (default: `None`). ~~Optional[Union[str, Path]]~~ |
#### spacy.ConsoleLogger.v3 {#ConsoleLogger tag="registered function"} #### spacy.ConsoleLogger.v3 {#ConsoleLogger tag="registered function"}
@ -583,14 +583,14 @@ start decreasing across epochs.
> ``` > ```
Writes the results of a training step to the console in a tabular format and Writes the results of a training step to the console in a tabular format and
saves them to a `jsonl` file. optionally saves them to a `jsonl` file.
| Name | Description | | Name | Description |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `progress_bar` | Type of progress bar to show in the console: `train` or `eval` | | `progress_bar` | Type of progress bar to show in the console: ``"train"`, `"eval"` or `None`. |
| | They track the number of steps until `training.max_steps` and `training.eval_frequency` are reached respectively.~~Optional[str]~~ | | | The bar tracks the number of steps until `training.max_steps` and `training.eval_frequency` are reached respectively (default: `None`).~~Optional[str]~~ |
| `console_output` | Whether the logger should print the logs in the console.~~bool~~ | | `console_output` | Whether the logger should print the logs in the console (default: `True`). ~~bool~~ |
| `output_file` | The file to save the training logs to. ~~Optional[Union[str, Path]]~~ | | `output_file` | The file to save the training logs to (default: `None`). ~~Optional[Union[str, Path]]~~ |
## Readers {#readers} ## Readers {#readers}