Skip to content

Commit 57f5158

Browse files
committed
improve weights_entry.authors doc string
1 parent 3a8e91c commit 57f5158

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

bioimageio/spec/model/v0_4.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,11 +160,11 @@ class WeightsEntryBase(Node, frozen=True):
160160
"""Attachments that are specific to this weights entry."""
161161

162162
authors: Union[Tuple[Author, ...], None] = None
163-
"""Authors:
164-
If this is the initial weights entry (in other words: it does not have a `parent` field):
165-
the person(s) that have trained this model.
166-
If this is a child weight (it has a `parent` field):
167-
the person(s) who have converted the weights to this format.
163+
"""Authors
164+
Either the person(s) that have trained this model resulting in the original weights file.
165+
(If this is the initial weights entry, i.e. it does not have a `parent`)
166+
Or the person(s) who have converted the weights to this weights format.
167+
(If this is a child weight, i.e. it has a `parent` field)
168168
"""
169169

170170
dependencies: Annotated[

bioimageio/spec/model/v0_5.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -813,11 +813,11 @@ class WeightsEntryBase(Node, frozen=True):
813813
"""SHA256 checksum of the source file"""
814814

815815
authors: Union[Tuple[Author, ...], None] = None
816-
"""Authors:
817-
If this is the initial weights entry (in other words: it does not have a `parent` field):
818-
the person(s) that have trained this model.
819-
If this is a child weight (it has a `parent` field):
820-
the person(s) who have converted the weights to this format.
816+
"""Authors
817+
Either the person(s) that have trained this model resulting in the original weights file.
818+
(If this is the initial weights entry, i.e. it does not have a `parent`)
819+
Or the person(s) who have converted the weights to this weights format.
820+
(If this is a child weight, i.e. it has a `parent` field)
821821
"""
822822

823823
parent: Annotated[Optional[WeightsFormat], Field(examples=["pytorch_state_dict"])] = None

0 commit comments

Comments
 (0)