Skip to content
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.

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

Minor fix: Typing and commentary #32

Merged
merged 1 commit into from
Dec 17, 2024
Merged
Changes from all commits
Commits
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
8 changes: 3 additions & 5 deletions torch_brain/utils/stitcher.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,16 +114,14 @@ class DecodingStitchEvaluator(L.Callback):
def __init__(
self,
session_ids: Iterable[str],
modality_spec: Optional[ModalitySpec] = None,
modality_spec: ModalitySpec,
quiet=False,
):
r"""
Args:
session_ids: An iterable of session IDs for which the metrics are to be computed.
modality_spec: (Optional) The modality specification for the task. Either this
or metric_factory must be provided.
metric_factory: (Optional) A callable that returns an instance of the metric to be used.
If not provided, the metric is inferred based on the modality_spec.
modality_spec: The modality specification for the task, used to decide
which metric function to use.
quiet: If True, disables the logging of the metrics to the console.
"""
self.quiet = quiet
Expand Down