Fix docstrings #22
Merged
Fix docstrings #22
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
added 8 commits
November 29, 2021 10:17
djdameln
reviewed
Dec 13, 2021
| """Call when the test begins.""" | ||
| """Call when the test begins. | ||
|
|
||
| Loads the model weights from into the PyTorch module. |
There was a problem hiding this comment.
Something's missing between from and into
djdameln
reviewed
Dec 13, 2021
anomalib/core/model/kde.py
Outdated
| tensor: torch.Tensor: Input tensor from which covariance matrix is computed. | ||
| bias: Optional[bool]: (Default value = False) | ||
| tensor (Tensor): Input tensor from which covariance matrix is computed. | ||
| bias (Optional[bool]): (Default value = False) |
There was a problem hiding this comment.
Can you add a description for this parameter?
djdameln
reviewed
Dec 13, 2021
| """Pre process the CNN features. | ||
|
|
||
| Args: | ||
| feature_stack: Features extracted from CNN | ||
| max_length: | ||
| feature_stack: torch.Tensor: | ||
| feature_stack: Tensor: | ||
| max_length: Optional[Tensor]: (Default value = None) |
There was a problem hiding this comment.
Descriptions are missing here
There was a problem hiding this comment.
Thanks! I missed these.
|
Few minor comments |
samet-akcay
reviewed
Dec 13, 2021
anomalib/models/dfm/dfm_model.py
Outdated
| C = U.S^2.U^T | ||
| This simplifies the calculation of the log-likelihood without requiring full matrix inversion. | ||
| Covariance matrix is not calculated directly using: | ||
| C = X.X^T |
There was a problem hiding this comment.
maybe we could have these equations within quotes to properly render in the docs
samet-akcay
reviewed
Dec 13, 2021
anomalib/models/dfm/model.py
Outdated
| batch: Dict: Input batch | ||
| batch_idx: int: Index of the batch. | ||
| batch (List[Dict[str, Any]]): Input batch | ||
| _ (int): Index of the batch. |
There was a problem hiding this comment.
We could remove this. It'll appear in the documentation, which won't make sense to the reader.
samet-akcay
requested changes
Dec 13, 2021
samet-akcay
approved these changes
Dec 24, 2021
djdameln
approved these changes
Dec 27, 2021
djdameln
pushed a commit
to djdameln/anomalib
that referenced
this pull request
Jan 2, 2025
Update metrics and evaluator guide
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.
Changes
Known Issues