Skip to content

Commit

Permalink
update docstring for upload_on_log (#1573)
Browse files Browse the repository at this point in the history
## Description

Updates `init()` docstring to describe `upload_on_log`

## Related

Relates to #1570


- [ ] I have reviewed the [Guidelines for Contributing](CONTRIBUTING.md)
and the [Code of Conduct](CODE_OF_CONDUCT.md).
  • Loading branch information
richard-rogers authored Oct 2, 2024
1 parent 0a76ed2 commit bba6725
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion python/whylogs/api/whylabs/session/session_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,8 @@ def init(
default_dataset_id: The default dataset id to use for uploading profiles. This is only used if the session is authenticated.
This is a convenience argument so that you don't have to supply the dataset id every time you upload a profile if
you're only using a single dataset id.
upload_on_log: If True, and the session type is WHYLOGS or WHYLOGS_ANONYMOUS, automaticall upload the profile to WhyLabs
from the why.log() function. By default, uploading to WhyLabs requires an explicit write() call from a WhyLabsWriter.
"""
if reinit:
SessionManager.reset()
Expand Down

0 comments on commit bba6725

Please sign in to comment.