Skip to content
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

Mention diffusion and bending energy loss demo in the docstrings #7380

Closed
kvttt opened this issue Jan 9, 2024 · 0 comments · Fixed by #7381
Closed

Mention diffusion and bending energy loss demo in the docstrings #7380

kvttt opened this issue Jan 9, 2024 · 0 comments · Fixed by #7381

Comments

@kvttt
Copy link
Contributor

kvttt commented Jan 9, 2024

Is your feature request related to a problem? Please describe.

Would be great to add the demo to the tutorial repo and mention it in the docstring.

Originally posted by @KumoLiu in #7272 (comment)

Describe the solution you'd like
Mention the demo in the docstring.

Describe alternatives you've considered
/

Additional context
/
@kvttt kvttt mentioned this issue Jan 9, 2024
Merged
7 tasks
KumoLiu pushed a commit that referenced this issue Jan 10, 2024
@kvttt
7380 mention demo in bending energy and diffusion docstrings (#7381)
e1ffa7e 
Fixes #7380.

### Description

Mention
[demo](https://github.com/Project-MONAI/tutorials/blob/main/modules/bending_energy_diffusion_loss_notes.ipynb)
in bending energy and diffusion docstrings.

### 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).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [ ] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [ ] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [x] Documentation updated, tested `make html` command in the `docs/`
folder.

---------

Signed-off-by: kaibo <ktang@unc.edu>
marksgraham pushed a commit to marksgraham/MONAI that referenced this issue Jan 30, 2024
@kvttt @marksgraham
7380 mention demo in bending energy and diffusion docstrings (Project…
ea0e89b 
…-MONAI#7381)

Fixes Project-MONAI#7380.

### Description

Mention
[demo](https://github.com/Project-MONAI/tutorials/blob/main/modules/bending_energy_diffusion_loss_notes.ipynb)
in bending energy and diffusion docstrings.

### 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).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [ ] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [ ] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [x] Documentation updated, tested `make html` command in the `docs/`
folder.

---------

Signed-off-by: kaibo <ktang@unc.edu>
Signed-off-by: Mark Graham <markgraham539@gmail.com>
juampatronics pushed a commit to juampatronics/MONAI that referenced this issue Mar 25, 2024
@kvttt @juampatronics
7380 mention demo in bending energy and diffusion docstrings (Project…
7cc7c9b 
…-MONAI#7381)

Fixes Project-MONAI#7380.

### Description

Mention
[demo](https://github.com/Project-MONAI/tutorials/blob/main/modules/bending_energy_diffusion_loss_notes.ipynb)
in bending energy and diffusion docstrings.

### 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).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [ ] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [ ] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [x] Documentation updated, tested `make html` command in the `docs/`
folder.

---------

Signed-off-by: kaibo <ktang@unc.edu>
Signed-off-by: Juan Pablo de la Cruz Gutiérrez <juampatronics@gmail.com>
Yu0610 pushed a commit to Yu0610/MONAI that referenced this issue Apr 11, 2024
@kvttt @Yu0610
7380 mention demo in bending energy and diffusion docstrings (Project…
329a7fa 
…-MONAI#7381)

Fixes Project-MONAI#7380.

### Description

Mention
[demo](https://github.com/Project-MONAI/tutorials/blob/main/modules/bending_energy_diffusion_loss_notes.ipynb)
in bending energy and diffusion docstrings.

### 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).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [ ] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [ ] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [x] Documentation updated, tested `make html` command in the `docs/`
folder.

---------

Signed-off-by: kaibo <ktang@unc.edu>
Signed-off-by: Yu0610 <612410030@alum.ccu.edu.tw>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

7380 mention demo in bending energy and diffusion docstrings kvttt/MONAI
1 participant
@kvttt