Update ray-tune.md #943
Merged
Update ray-tune.md #943
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -7,7 +7,7 @@ | |||
|
|
|||
| W&B integrates with [Ray](https://github.com/ray-project/ray) by offering two lightweight integrations. | |||
|
|
|||
| One is the `WandbLoggerCallback`, which automatically logs metrics reported to Tune to the Wandb API. The other one is the `@wandb_mixin` decorator, which can be used with the function API. It automatically initializes the Wandb API with Tune’s training information. You can just use the Wandb API like you would normally do, e.g. using `wandb.log()` to log your training process. | |||
| One is the `WandbLoggerCallback`, which automatically logs metrics reported to Tune to the Wandb API. The other one is the `setup_wandb()` function, which can be used with the function API. It automatically initializes the Wandb API with Tune's training information. You can just use the Wandb API like you would normally do, e.g. using `wandb.log()` to log your training process. | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be used').
| `excludes (list)` – List of metrics that should be excluded from the `log`. | ||
| `excludes (list)` – List of metrics that should be excluded from the log. | ||
|
|
||
| `log_config (bool)` – Boolean indicating if the config parameter of the results dict should be logged. Defaults to False. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be logged').
|
|
||
| `log_config (bool)` – Boolean indicating if the config parameter of the results dict should be logged. This makes sense if parameters will change during training, e.g. with `PopulationBasedTraining`. Defaults to False. | ||
| `upload_checkpoints (bool)` - If True, model checkpoints will be uploaded to Wandb as artifacts. Defaults to False. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be uploaded').
Deploying docodile with
|
| Latest commit: |
97103d2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cacf103a.docodile.pages.dev |
| Branch Preview URL: | https://fix-ray-docs.docodile.pages.dev |
mdlinville
reviewed
Dec 11, 2024
mdlinville
reviewed
Dec 11, 2024
mdlinville
reviewed
Jan 9, 2025
mdlinville
reviewed
Jan 9, 2025
| @@ -7,7 +7,8 @@ title: Ray Tune | |||
|
|
|||
| W&B integrates with [Ray](https://github.com/ray-project/ray) by offering two lightweight integrations. | |||
|
|
|||
| One is the `WandbLoggerCallback`, which automatically logs metrics reported to Tune to the Wandb API. The other one is the `@wandb_mixin` decorator, which can be used with the function API. It automatically initializes the Wandb API with Tune’s training information. You can just use the Wandb API like you would normally do, e.g. using `wandb.log()` to log your training process. | |||
| - The`WandbLoggerCallback` function automatically logs metrics reported to Tune to the Wandb API. | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'wandb' instead of 'Wandb'.
| @@ -7,7 +7,8 @@ | |||
|
|
|||
| W&B integrates with [Ray](https://github.com/ray-project/ray) by offering two lightweight integrations. | |||
|
|
|||
| One is the `WandbLoggerCallback`, which automatically logs metrics reported to Tune to the Wandb API. The other one is the `@wandb_mixin` decorator, which can be used with the function API. It automatically initializes the Wandb API with Tune’s training information. You can just use the Wandb API like you would normally do, e.g. using `wandb.log()` to log your training process. | |||
| - The`WandbLoggerCallback` function automatically logs metrics reported to Tune to the Wandb API. | |||
| - The `setup_wandb()` function, which can be used with the function API, automatically initializes the Wandb API with Tune's training information. You can use the Wandb API as usual. such as by using `wandb.log()` to log your training process. | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be used').
| @@ -7,7 +7,8 @@ | |||
|
|
|||
| W&B integrates with [Ray](https://github.com/ray-project/ray) by offering two lightweight integrations. | |||
|
|
|||
| One is the `WandbLoggerCallback`, which automatically logs metrics reported to Tune to the Wandb API. The other one is the `@wandb_mixin` decorator, which can be used with the function API. It automatically initializes the Wandb API with Tune’s training information. You can just use the Wandb API like you would normally do, e.g. using `wandb.log()` to log your training process. | |||
| - The`WandbLoggerCallback` function automatically logs metrics reported to Tune to the Wandb API. | |||
| - The `setup_wandb()` function, which can be used with the function API, automatically initializes the Wandb API with Tune's training information. You can use the Wandb API as usual. such as by using `wandb.log()` to log your training process. | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'wandb' instead of 'Wandb'.
| @@ -7,7 +7,8 @@ | |||
|
|
|||
| W&B integrates with [Ray](https://github.com/ray-project/ray) by offering two lightweight integrations. | |||
|
|
|||
| One is the `WandbLoggerCallback`, which automatically logs metrics reported to Tune to the Wandb API. The other one is the `@wandb_mixin` decorator, which can be used with the function API. It automatically initializes the Wandb API with Tune’s training information. You can just use the Wandb API like you would normally do, e.g. using `wandb.log()` to log your training process. | |||
| - The`WandbLoggerCallback` function automatically logs metrics reported to Tune to the Wandb API. | |||
| - The `setup_wandb()` function, which can be used with the function API, automatically initializes the Wandb API with Tune's training information. You can use the Wandb API as usual. such as by using `wandb.log()` to log your training process. | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'wandb' instead of 'Wandb'.
| @@ -21,101 +22,81 @@ | |||
|
|
|||
| ### Parameters | |||
|
|
|||
| `api_key_file (str)` – Path to file containing the `Wandb API KEY`. | |||
| `project (str)`: Name of the Wandb project. Mandatory. | |||
There was a problem hiding this comment.
[Google.Colons] ': N' should be in lowercase.
|
|
||
| `excludes (list)` – List of metrics that should be excluded from the `log`. | ||
| `api_key (str)`: Wandb API Key. Alternative to setting `api_key_file`. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'wandb' instead of 'Wandb'.
|
|
||
| `log_config (bool)` – Boolean indicating if the config parameter of the results dict should be logged. This makes sense if parameters will change during training, e.g. with `PopulationBasedTraining`. Defaults to False. | ||
| `excludes (list)`: List of metrics to exclude from the log. |
There was a problem hiding this comment.
[Google.Colons] ': L' should be in lowercase.
| `log_config (bool)` – Boolean indicating if the config parameter of the results dict should be logged. This makes sense if parameters will change during training, e.g. with `PopulationBasedTraining`. Defaults to False. | ||
| `excludes (list)`: List of metrics to exclude from the log. | ||
|
|
||
| `log_config (bool)`: Whether to log the config parameter of the results dictionary. Defaults to False. |
There was a problem hiding this comment.
[Google.Colons] ': W' should be in lowercase.
|
|
||
| `log_config (bool)`: Whether to log the config parameter of the results dictionary. Defaults to False. | ||
|
|
||
| `upload_checkpoints (bool)`: If True, model checkpoints are uploaded as artifacts. Defaults to False. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are uploaded').
| This Ray Tune Trainable `mixin` helps initializing the Wandb API for use with the `Trainable` class or with `@wandb_mixin` for the function API. | ||
|
|
||
| For basic usage, just prepend your training function with the `@wandb_mixin` decorator: | ||
| This utility function helps initialize Wandb for use with Ray Tune. For basic usage, call `setup_wandb()` in your training function: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'wandb' instead of 'Wandb'.
mdlinville
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
What does the pull request do? If it fixes a bug or resolves a feature request, be sure to link to that issue.
Ticket
Does this PR fix an existing issue? If yes, provide a link to the ticket here: https://wandb.atlassian.net/browse/GROWTH2-358
Checklist
Check if your PR fulfills the following requirements. Put an
Xin the boxes that apply.yarn start. My changes did not break the local preview.yarn docusaurus build) was run locally and successfully without errors or warnings.maininto my feature branch before submitting this PR.