Update Inference Scripts in README to Match Project Structure #313
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
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.
Summary:
This PR introduces updates to the inference scripts, ensuring they accurately reflect the current project structure. Previously, users encountered errors when attempting to run inference due to outdated script paths and configurations. This update aims to streamline the user experience, enabling straightforward execution of inference scripts without the need for troubleshooting or modifications.
Changes:
Updated the paths within the inference scripts to match the latest project directory structure.
Ensured that all referenced configurations in the scripts are accurate and up-to-date, reflecting the current setup of the project.
Modified script examples in the documentation to prevent confusion and guide users more effectively.
Testing:
The changes have been tested with the following commands, confirming that the scripts now run smoothly without errors:
python -m scripts.animate --config configs/prompts/1-ToonYou.yaml
python -m scripts.animate --config configs/prompts/3-RcnzCartoon.yaml
python -m scripts.animate --config configs/prompts/v1/v1-1-ToonYou.yaml
python -m scripts.animate --config configs/prompts/v3/v3-3-RcnzCartoon.yaml
Impact:
These updates significantly improve the usability of the inference scripts, reducing potential friction for new users and contributing to a more intuitive getting-started process. By aligning the scripts with the current project structure, we also minimize the risk of future discrepancies as the project evolves.
Request for Review:
I invite reviewers to test the updated scripts in their environments to verify the improvements and suggest any further refinements. Your feedback is invaluable to ensure that these changes meet our quality standards and user expectations.