Skip to content

AutoencoderKL docstrings have reference to num_channels instead of channels #8444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
virginiafdez opened this issue May 9, 2025 · 1 comment · Fixed by #8445
Closed

AutoencoderKL docstrings have reference to num_channels instead of channels #8444

virginiafdez opened this issue May 9, 2025 · 1 comment · Fixed by #8445
Assignees
@virginiafdez
Labels
documentation Improvements or additions to documentation

Comments

@virginiafdez
Copy link
Contributor

Describe the bug
In AutoencoderKL (https://github.com/Project-MONAI/MONAI/blob/dev/monai/networks/nets/autoencoderkl.py) the docstrings of the Encoder, Decoder and AutoencoderKL refer to num_channels although the argument is called channels.
@virginiafdez virginiafdez self-assigned this May 9, 2025
@virginiafdez virginiafdez added the documentation Improvements or additions to documentation label May 9, 2025
@virginiafdez virginiafdez mentioned this issue May 9, 2025
Merged
3 tasks
@virginiafdez
Copy link
Contributor Author

This issue is solved by PR#8445.

ericspod added a commit that referenced this issue May 16, 2025
@virginiafdez @ericspod
Fix AutoencoderKL docstrings. (#8445)
03a0d85 
Fixes #8444 

### Description

Some of the docstrings in AutoencoderKL, Encoder and Decoder within
autoencoderkl.py and some of the errors related to argument "channels"
make reference to "num_channels" instead.

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [X] Non-breaking change (fix or new feature that would not break
existing functionality).
- [X] In-line docstrings updated.
- [X] Documentation updated, tested `make html` command in the `docs/`
folder.

---------

Signed-off-by: Virginia Fernandez <[email protected]>
Co-authored-by: Virginia Fernandez <[email protected]>
Co-authored-by: Eric Kerfoot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@virginiafdez virginiafdez

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix AutoencoderKL docstrings. virginiafdez/MONAI
1 participant
@virginiafdez