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.

Sign up for GitHub

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

Jump to bottom

standardization #1

Open

xnought opened this issue Mar 7, 2023 · 3 comments

Contributor

xnought commented Mar 7, 2023 •

edited

Loading

Standardize every example so people can easily

download data
download necessary dependencies
run zeno with this example they want

Contributor Author

xnought commented Mar 7, 2023 •

edited

Loading

maybe the structure per example could be

example_folder
- zeno_metadata/ directory (place to keep metadata (or just do zeno_metadata.csv or whatever if one file))
- zeno_functions/ directory (place to keep functions (or just do zeno_functions.py if one file))
- zeno_config.toml
- requirements.txt (python dependencies list)
- download.sh or download.py (for downloading data and dependencies)
- README.md (purpose of this example, what it uniquely illustrates, explanation for choices in configuration, and how to download stuff to run)

Contributor Author

xnought commented Mar 7, 2023 •

edited

Loading

@cabreraalex thoughts? Also can I have permissions to this repo so I can assign myself to this?

Member

cabreraalex commented Mar 7, 2023

I'm sold I can try to give it a go soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment