Skip to content

change folder name generative to generation #1767

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.

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

Merged
merged 6 commits into from
Aug 7, 2024

Conversation

Can-Zhao
Copy link
Contributor

@Can-Zhao Can-Zhao commented Aug 1, 2024

Fixes # .

Description

change folder name generative to generation

Checks

  • Avoid including large-size files in the PR.
  • Clean up long text outputs from code cells in the notebook.
  • For security purposes, please check the contents and remove any sensitive info such as user names and private key.
  • Ensure (1) hyperlinks and markdown anchors are working (2) use relative paths for tutorial repo files (3) put figure and graphs in the ./figure folder
  • Notebook runs automatically ./runner.sh -t <path to .ipynb file>

@Can-Zhao Can-Zhao marked this pull request as ready for review August 1, 2024 19:03
@ericspod
Copy link
Member

ericspod commented Aug 2, 2024

We've always called it "Generative AI", I think the name makes sense to refer to that term though it differs from many other names in tutorials currently. Was there a particular reason you thought this needed renaming? We should check no URLs get broken by this, eg. Colab links in notebooks.

@Can-Zhao
Copy link
Contributor Author

Can-Zhao commented Aug 2, 2024

We've always called it "Generative AI", I think the name makes sense to refer to that term though it differs from many other names in tutorials currently. Was there a particular reason you thought this needed renaming? We should check no URLs get broken by this, eg. Colab links in notebooks.

I remember there was concern when people import package generative and import the function under this folder generative at the same time. There might be potential risk. Changing folder name is a low-cost solution to avoid such risk

@KumoLiu
Copy link
Contributor

KumoLiu commented Aug 5, 2024

Hi @Can-Zhao, thanks for the pr, please also updated related "Setup environment" section.
https://github.com/Project-MONAI/tutorials/blob/main/generative/maisi/maisi_inference_tutorial.ipynb
https://github.com/Project-MONAI/tutorials/blob/main/generative/maisi/maisi_train_vae_tutorial.ipynb

And @ericspod, yes, just like what Can mentioned, the main issue here is that import generative will cause conflict. Do you have more concern to change these folder names? Thanks!

@Can-Zhao
Copy link
Contributor Author

Can-Zhao commented Aug 5, 2024

Hi @Can-Zhao, thanks for the pr, please also updated related "Setup environment" section. https://github.com/Project-MONAI/tutorials/blob/main/generative/maisi/maisi_inference_tutorial.ipynb https://github.com/Project-MONAI/tutorials/blob/main/generative/maisi/maisi_train_vae_tutorial.ipynb

And @ericspod, yes, just like what Can mentioned, the main issue here is that import generative will cause conflict. Do you have more concern to change these folder names? Thanks!

Hi Yun, the generative imported in notebooks are from generative repo, not this tutorial generative.

@KumoLiu
Copy link
Contributor

KumoLiu commented Aug 5, 2024

Hi Yun, the generative imported in notebooks are from generative repo, not this tutorial generative.

I know, I mean remove the print statement which is temporarily used to avoid the conflict.

@ericspod
Copy link
Member

ericspod commented Aug 6, 2024

I remember there was concern when people import package generative and import the function under this folder generative at the same time. There might be potential risk. Changing folder name is a low-cost solution to avoid such risk

My understanding then is if someone imports "generative" with the current working directory as the root of this repo, they'll import the directory here "generative" rather than the GenerativeModels module. That seems a valid concern, even though GenerativeModels is going to become archived when the porting process is done it will still be used. I'm good with this change, thanks.

@Can-Zhao Can-Zhao reopened this Aug 6, 2024
Signed-off-by: Can-Zhao <[email protected]>
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Can-Zhao
Copy link
Contributor Author

Can-Zhao commented Aug 6, 2024

Hi Yun, the generative imported in notebooks are from generative repo, not this tutorial generative.

I know, I mean remove the print statement which is temporarily used to avoid the conflict.

Done

@Can-Zhao
Copy link
Contributor Author

Can-Zhao commented Aug 6, 2024

I remember there was concern when people import package generative and import the function under this folder generative at the same time. There might be potential risk. Changing folder name is a low-cost solution to avoid such risk

My understanding then is if someone imports "generative" with the current working directory as the root of this repo, they'll import the directory here "generative" rather than the GenerativeModels module. That seems a valid concern, even though GenerativeModels is going to become archived when the porting process is done it will still be used. I'm good with this change, thanks.

Thanks

Copy link
Member

@ericspod ericspod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm good if others are. Thanks!

@KumoLiu KumoLiu merged commit 1c942f4 into Project-MONAI:main Aug 7, 2024
6 checks passed
@Can-Zhao Can-Zhao deleted the mv_generation branch August 7, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants