search

wandb / wandb

The AI developer platform. Use Weights & Biases to train and fine-tune models, and manage models from experimentation to production.
https://wandb.ai
MIT License
9.1k stars 673 forks source link

[CLI]: missing documentation for init settings argument #6936

Open JonasLoos opened 9 months ago

JonasLoos commented 9 months ago

Describe the bug

While browsing the documentation for an issue I had, I stumbled over the the wandb.init settings argument here. However, in the documentation for init, the description for settings is missing.

When scrolling through the corresponding source code, linked in the docs, I coudn't find an obvious use of the settings argument. So, I'm unsure if the documentation is missing, or if the the settings argument is unused.

Additional Files

No response

Environment

WandB version: v0.16.1

Additional Context

No response

umakrishnaswamy commented 9 months ago

hey @JonasLoos - you are correct that this information isn't directly available in our docs, but I recommend checking the source code here to see all the arguments you could adjust.

In general, wandb.Settings has many flags ranging from being able to silence wandb output to adjusting the flags that fork new processes. Please let me know if you have any specific issue/goal in mind and I would love to help

JonasLoos commented 9 months ago

Thanks for your answer!

The issue was supposed to be more of a bug report. In case this is supposed to not be in the docs, this issue can be closed.

tristanengst commented 8 months ago

+1 Adding these settings to the documentation would be very useful!

kptkin commented 7 months ago

@tristanengst @JonasLoos it is used, however not all settings are finalized and we avoided documenting some of them. There are many settings and not all of them will make the cut for settings we want to support going forward, saying this, we currently working on documenting and finalizing the settings and will be adding to our documentation soon.

Saying that all the settings are usable and there are many useful ones that allow more fine-grained control of how wandb works.