[DOCS-466] Standardize docs about creating API keys and signing in #1054
Conversation
- Update each integration to use the same headings and structure - Fix other section headings in the integrations - Use the same details in the public API guide - Use the same details in the quickstart
mdlinville
requested review from
ngrayluna
and removed request for
chrishiste
Deploying docs with
|
| Latest commit: |
8656150
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://36b01a0a.docodile.pages.dev |
| Branch Preview URL: | https://docs-466.docodile.pages.dev |
| @@ -240,9 +250,9 @@ wandb.config.update({"model_parameters": 3500}) | |||
|
|
|||
| For more information on how to define a config file, see [Configure Experiments with wandb.config]({{< relref "/guides/models/track/config" >}}). | |||
|
|
|||
| ### Logging To W&B | |||
| ### Log o W&B | |||
|
|
||
| ```python |
There was a problem hiding this comment.
WandbLogger refers to a Class that makes it easier to log checkpoints, metrics, etc. for folks using DeepChem.
There was a problem hiding this comment.
I.e. So you still need the import statements.
| {{% /tab %}} | ||
|
|
||
| {{% tab header="Python" value="python" %}} |
There was a problem hiding this comment.
The example below could be Python, but you'd need to remove the ! in the pip install statement.
Or, rename "Python" to "Python notebook", "Juptyer Notebook", "Google Colab", etc.
There was a problem hiding this comment.
This applies to this example, and all the other markdown files in this PR.
| {{< /tabpane >}} | ||
|
|
||
| ### 2. Name the project | ||
| If you are using Weights and Biases for the first time you might want to check out our [**quickstart**]({{< relref "/guides/quickstart.md" >}}) |
There was a problem hiding this comment.
Nit: Rename "Weights & Biases" to "W&B"
content/guides/integrations/yolox.md
Outdated
|
|
||
| ## Log metrics | ||
|
|
||
| Use the `--logger wandb` command line argument to turn on logging with wandb. Optionally you can also pass all of the arguments that [wandb.init]({{< relref "/ref/python/init" >}}) would expect, just prepend `wandb-` to the start of each argument |
There was a problem hiding this comment.
Use wandb if referring to Py module. Or, if referring to the company, use "W&B"
DOCS-466 Standardize docs about creating API keys and signing in
The original request asked for a dedicated page with these details, and to point the integrations at that page. That's not ideal because they need to go read that page and then come back to the integration page. Ideally that "Create an API key" page would be a sibling to the Quickstart, but I think it would actually look quite strange. See the left hand when you are viewing https://docs.wandb.ai/quickstart/ to see what I mean.
Ideally I could save this content to one or two includes which could then be included by each of the integrations, but I ran into issues with caching and with Docsy shortcodes not being evaluated within the includes. So this uses a more brute force approach for now.