From 7e793ded5a654f3152b914fbb6a05c5de0f16fe6 Mon Sep 17 00:00:00 2001 From: shademe Date: Thu, 22 Dec 2022 17:16:31 +0100 Subject: [PATCH] Add defaults to docs Minor fixes --- website/docs/api/top-level.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/website/docs/api/top-level.md b/website/docs/api/top-level.md index fc30b086a..e401a4d9b 100644 --- a/website/docs/api/top-level.md +++ b/website/docs/api/top-level.md @@ -513,7 +513,7 @@ a [Weights & Biases](https://www.wandb.com/) dashboard. Instead of using one of the built-in loggers, you can [implement your own](/usage/training#custom-logging). -#### spacy.ConsoleLogger.v2 {#ConsoleLogger tag="registered function"} +#### spacy.ConsoleLogger.v2 {tag="registered function"} > #### Example config > @@ -564,11 +564,11 @@ start decreasing across epochs. -| Name | Description | -| ---------------- | -------------------------------------------------------------------------------------------------------- | -| `progress_bar` | Whether the logger should print a progress bar tracking the steps till the next evaluation pass.~~bool~~ | -| `console_output` | Whether the logger should print the logs in the console. ~~bool~~ | -| `output_file` | The file to save the training logs to. ~~Optional[Union[str, Path]]~~ | +| Name | Description | +| ---------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `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 (default: `True`). ~~bool~~ | +| `output_file` | The file to save the training logs to (default: `None`). ~~Optional[Union[str, Path]]~~ | #### 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 -saves them to a `jsonl` file. +optionally saves them to a `jsonl` file. -| Name | Description | -| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `progress_bar` | Type of progress bar to show in the console: `train` or `eval` | -| | They track the number of steps until `training.max_steps` and `training.eval_frequency` are reached respectively.~~Optional[str]~~ | -| `console_output` | Whether the logger should print the logs in the console.~~bool~~ | -| `output_file` | The file to save the training logs to. ~~Optional[Union[str, Path]]~~ | +| Name | Description | +| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `progress_bar` | Type of progress bar to show in the console: ``"train"`, `"eval"` or `None`. | +| | 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 (default: `True`). ~~bool~~ | +| `output_file` | The file to save the training logs to (default: `None`). ~~Optional[Union[str, Path]]~~ | ## Readers {#readers}