V2: fix some docstrings #654
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
hwpang
reviewed
Feb 29, 2024
chemprop/nn/agg.py
Outdated
| @@ -47,15 +47,15 @@ def forward(self, H: Tensor, batch: Tensor) -> Tensor: | |||
| Parameters | |||
| ---------- | |||
| H : Tensor | |||
| A tensor of shape ``V x d`` containing the batched node-level representations of ``n`` | |||
| A tensor of shape ``V x d`` containing the batched node-level representations of ``b`` | |||
There was a problem hiding this comment.
It is defined here in message_passing base.py. We could define b here and probably should, but at the same time we don't define what V and d are. Additionally there are many docstrings that use variables without defining them each time. I think it would be better to collect all the variable definitions into a single reference like what some textbooks do, but that is fairly big task.
hwpang
approved these changes
Mar 1, 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.
Description
As I've read through the code base, I've seen some parts of docstrings that looked incorrect. Some of these are more obvious than others. I've carefully reviewed these changes, but will appreciate another pair of eyes on it before we go to merge.