docs: complement and rewrite evaluation docs#662
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## main #662 +/- ##
==========================================
+ Coverage 85.24% 86.46% +1.22%
==========================================
Files 133 133
Lines 6762 6762
==========================================
+ Hits 5764 5847 +83
+ Misses 998 915 -83
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
NicholasDunham
approved these changes
Oct 21, 2022
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Goals:
At the beginning of the page, I explain what
evaluate()does a bit more clearly.add documentation for the
metric_namespropertyadd documentation on how to implement a custom metric function
Restructure the docs so that it makes a bit more sense
check and update documentation, if required. See guide