Initial documentation#53
Merged
Merged
Conversation
juntyr
reviewed
Aug 5, 2025
Collaborator
juntyr
left a comment
juntyr
left a comment
There was a problem hiding this comment.
LGTM so far, I left a few nits
| nav: | ||
| - Home: index.md | ||
| - Tutorials: | ||
| - Run the benchmark: run_benchmark.md |
Collaborator
There was a problem hiding this comment.
Is this file still missing?
Member
Author
There was a problem hiding this comment.
Ups yes, it's added now!
| class ErrorBound(Test): | ||
| def __init__(self, error_type: str, threshold: float = 0.05): | ||
| """Tests whether the absolute or relative error between two arrays is below a threshold. | ||
|
|
Collaborator
There was a problem hiding this comment.
Maybe mention here that infinite values need to be preserved exactly and that NaNs must stay NaNs
Co-authored-by: Juniper Tyree <50025784+juntyr@users.noreply.github.com>
…or into documentation
Member
Author
|
Thanks @juntyr ! I have added the missing tutorial now and fixed the other nibbles. |
Member
Author
|
@juntyr do you have any objections against me merging this? |
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
2 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.
This adds some bare-bones documentation and details for how to run the pipeline.
I'll
clean up the docstrings andadd details on how to add compressors/metrics in a later PR.