Skip to content

fix WandbLoggerConfig include additional kwargs in pydantic schema #3469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
deruyter92 wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −2
Draft

fix WandbLoggerConfig include additional kwargs in pydantic schema #3469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion deeplabcut/pose_estimation_pytorch/config/logger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,27 @@ class WandbLoggerConfig(LoggerConfig): #
type: Logger type (should be 'WandbLogger')
project_name: The name of the wandb project
run_name: The name of the wandb run
entity: The wandb user or team under which the run is logged
notes: A longer description of the run, displayed in the wandb UI
tags: Tags for the run, used to organize and filter runs in the wandb UI
group: The name of the group to which this run belongs
job_type: The type of job being logged (e.g. 'train' or 'eval')
image_log_interval: How often train/test images are logged in epochs
(if None, train/test inputs are never logged)
model: The model architecture to log
train_folder: The path of the folder containing training files.
wandb_kwargs: Additional keyword arguments to pass to wandb.init
wandb_kwargs: Additional keyword arguments to pass to wandb.init. Use this for
wandb.init parameters which are not declared above.
"""

type: Literal[LoggerType.WandbLogger]
project_name: str = "deeplabcut"
run_name: str = "tmp"
entity: str | None = None
notes: str | None = None
tags: list[str] | None = None
group: str | None = None
job_type: str | None = None
image_log_interval: int | None = None
model: dict | None = None
train_folder: str | None = None
Expand Down
7 changes: 6 additions & 1 deletion deeplabcut/pose_estimation_pytorch/runners/logger.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,9 @@ def __init__(
None, train/test inputs are never logged).
model: The model to log. Defaults to None.
train_folder: path to the train folder (used to store the W&B run identifiers)
wandb_kwargs: extra arguments to pass to ``wb.init``
wandb_kwargs: extra arguments to pass to ``wb.init``. These can be given as
keyword arguments, or collected in a single ``wandb_kwargs`` mapping (as
declared by ``WandbLoggerConfig``).

Example:
logger = WandbLogger(project_name="mice", run_name="exp1", model=my_model)
Expand All @@ -291,6 +293,9 @@ def __init__(
if wandb.run is not None:
wandb.finish()

# A nested ``wandb_kwargs``mapping must be flattened
wandb_kwargs.update(wandb_kwargs.pop("wandb_kwargs", None) or {})

self.run = wandb.init(
project=project_name,
name=run_name,
Expand Down
Loading