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.

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

Clarify the meaning of remote when giving NGen image run options #121

Merged
merged 1 commit into from
Mar 1, 2024

Conversation

jameshalgren
Copy link
Member

@jameshalgren jameshalgren commented Mar 1, 2024

TL;DR

This fixes confusing language in the guide script. Please feel free to suggest something better.

More detail

The guide script has a prompt to give the user the option to run with an existing container or to pull a 'fresh' version from the docker repository.

This commit changes the language in that prompt from a somewhat confusing:

1) Run NextGen Model using local docker image
2) Run Nextgen using remote docker image
3) Exit

(aren't all docker images local? what am I getting in a remote image?)

... to the (hopefully) more clear:

1) Run NextGen using existing local docker image	      
2) Run NextGen after updating to latest docker image
3) Exit

The idea is that the #1 "local" run does not go recompile or rebuild anything, so it might be the best option if you have a setup that is working and you simply want to re-run to reproduce a result (or see a new result from a slightly modified ngen realization, etc.) The #2 "remote" option goes to dockerhub and grabs the latest updates -- useful if you are having problems or trying to test out recently released functionality.

(Note -- changed "NextGen Model" to just "NextGen" to reflect the standard language.)

@jameshalgren jameshalgren requested a review from JoshCu March 1, 2024 00:40
@jameshalgren
Copy link
Member Author

jameshalgren commented Mar 1, 2024

This is a one-liner.Do the lines in the select-case statement immediately following also need to be updated?
Answer -- yes they do. Converting to draft until fixed...

Fixed. Ready for review.

@jameshalgren jameshalgren marked this pull request as draft March 1, 2024 00:43
@jameshalgren jameshalgren force-pushed the clarify_local_remote_image branch from c3cf644 to f944860 Compare March 1, 2024 16:05
@jameshalgren jameshalgren marked this pull request as ready for review March 1, 2024 16:07
@jameshalgren jameshalgren requested a review from benlee0423 March 1, 2024 16:07
@jameshalgren jameshalgren force-pushed the clarify_local_remote_image branch from f944860 to 1f0745a Compare March 1, 2024 16:09
@benlee0423 benlee0423 closed this Mar 1, 2024
@benlee0423 benlee0423 reopened this Mar 1, 2024
@benlee0423 benlee0423 merged commit 8411887 into CIROH-UA:main Mar 1, 2024
10 checks passed
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.

2 participants