add docstrings #15
Merged
add docstrings #15
Conversation
This file contains hidden or 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
windisch
approved these changes
Jun 5, 2025
driftbench/benchmarks/data.py
Outdated
| name (str): The name of the dataset specification. | ||
| spec (dict): The yaml-specification of the dataset. | ||
| f (Callable): The function to fit the curves. | ||
| w0 (list[float]): The inital guess. |
Collaborator
There was a problem hiding this comment.
Suggested change
| w0 (list[float]): The inital guess. | |
| w0 (np.ndarray): The inital value. |
Owner
Author
There was a problem hiding this comment.
Maybe something like:
Suggested change
| w0 (list[float]): The inital guess. | |
| w0 (np.ndarray): The inital value for the internal paramters. |
?
Co-authored-by: Tobias Windisch <[email protected]>
Co-authored-by: Tobias Windisch <[email protected]>
Owner
Author
|
@windisch Have added/fixed some older docstrings and made sure everything gets now rendered properly. |
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.
No description provided.