-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Test new docstrings and apidocs deployment #3573
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FYI @helpmefindaname @konstantin-lukas - examples are not yet formatted in the template. For now, I'll just exclude examples from the code comments. Here's how the following docstring looks like: def add_label(self, typename: str, value: str, score: float = 1.0, **metadata) -> "DataPoint":
"""Adds a label to the :class:`DataPoint` by internally creating a :class:`Label` object.
Examples:
>>> sentence = Sentence("this is good")
>>> sentence.add_label("sentiment", "positive")
>>> print(sentence)
Sentence[3]: "this is good" → positive (1.0000)
>>> # make a sentence and get the last token
>>> sentence = Sentence("this is good")
>>> token = sentence[2]
>>> # add a label to token
>>> token.add_label("part-of-speech", "adjective")
>>> print(token)
Token[2]: "good" → adjective (1.0000)
Args:
typename: A string that identifies the layer of annotation, such as "ner" for named entity labels or "sentiment" for sentiment labels
value: A string that sets the value of the label.
score: Optional value setting the confidence level of the label (between 0 and 1). If not set, a default confidence of 1 is used.
**metadata: Additional metadata information.
Returns:
A pointer to itself (DataPoint object, now with an added label).
""" |
helpmefindaname
approved these changes
Dec 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds docstrings to the
get_label
method and tests whether the "Returns:" description in the docstrings is correctly displayed.