standardization - Githubissues

zeno-ml / examples

Example Zeno projects

2 stars 1 forks source link

standardization #1

Open xnought opened 1 year ago

xnought commented 1 year ago

Standardize every example so people can easily

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

xnought commented 1 year ago

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)

xnought commented 1 year ago

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

cabreraalex commented 1 year ago

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