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

[Short term] Clean up the open source code to make it maximally convenient for new people to get set up and running it. #2

Open
pashpashpash opened this issue Apr 16, 2024 · 0 comments

Comments

@pashpashpash
Copy link
Owner

pashpashpash commented Apr 16, 2024

This is a more general task, but it's important to clean up the code. Right now it's a bit of a mess with python objects being created with unstandardized parameters (for example, the volume object, narration_script, movie_script object, etc. These should likely be classes instead of objects.

The goal here is for the source code to be cleanly organized into understandable, standardized objects/classes/functions so that even people with a limited understanding of code can feel like they can modify the behavior of the code to their liking. This will also help other developers get involved and understand what the code does.

Lastly, the README should be updated to include all of the setup steps, as right now certain things are excluded (i.e. needing to set up torch among other libraries prior to running)

image

@pashpashpash pashpashpash changed the title Clean up the open source code to make it maximally convenient for new people to get set up and running it. [Short term] Clean up the open source code to make it maximally convenient for new people to get set up and running it. Apr 16, 2024
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

No branches or pull requests

1 participant