search

jaketae / storyteller

Multimodal AI Story Teller, built with Stable Diffusion, GPT, and neural text-to-speech
MIT License
482 stars 64 forks source link

CLI Interface Detailed Specification and Instructions Examples Update #14

Closed iluxonchik closed 11 months ago

iluxonchik commented 1 year ago

This Merge Request addresses issue https://github.com/jaketae/storyteller/issues/13 where the storyteller --help command does not provide enough information about the arguments. The argparse module is used to handle command-line arguments, but the descriptions and defaults were not added to the arguments.

To fix this issue, I have added detailed descriptions and default values to the arguments in the argparse code. In the process I have also refactored parts the code, which I have made more modular.

As a result, when running storyteller --help, the arguments will have clear descriptions and defaults, making it easier for users to understand how to use the command-line interface. I have also updated the documentation to reflect the changes made to the command-line interface. In addition, I have added a clearer example on how to run the demo using custom parameters in the README.

I was not able to install the git pre-commit hooks, as the dev target appears to be missing. I did however, format the code using Black, as is mentioned in the repository description.

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

jaketae commented 11 months ago

Hi @iluxonchik, thank you for opening the issue as well as proposing a fix! Having helpful guide text for the CLI is certainly helpful. Thanks for the contribution!