[Feature]: Improved documentation for WANDB_SWEEP_ID env variable

[mklasby]

Description

Documentation for enviornment variables does not include information on WANDB_SWEEP_ID. This can lead to a problem when calling wandb.init() with id, project, or entity parameters if this enviornment variable has been set. This can result in crashes or unexpected behaviour, particularlly when trying to a resume a run that was part of a sweep but crashed/ failed prematurely.

Suggested Solution

Add information regarding WANDB_SWEEP_ID to the online documentation

Alternatives

Do not ignore wandb.init() parameters when script is executed directly by user rather than sweep agent initalized with wandb agent. Provide warnings to user if env variable is set and wandb agent is not used to start run.

Additional Context

No response

[luisbergua]

Hi @mklasby, thanks for suggesting this! I'll share this feedback with our team.

[rajveer43]

Is this issue open for work?

[luisbergua]

Hey @rajveer43, are you asking about submitting a PR to add this information to our docs?

[rajveer43]

Hey @rajveer43, are you asking about submitting a PR to add this information to our docs?

yes!

[luisbergua]

Hi @rajveer43, thank you for your patience! After checking this internally, our team would like to connect with you so I have just sent an email introducing the team, will follow up there!

[rajveer43]

thank you. I have replied to that email!