slickml / slick-ml

SlickML 🧞: Slick Machine Learning in Python
https://www.SlickML.com
MIT License
27 stars 8 forks source link

[FEATURE]: Make each example in examples directory a standalone Poetry project #91

Open amirhessam88 opened 2 years ago

amirhessam88 commented 2 years ago

Contact Details [Optional]

No response

Describe the feature you are interested in ...

Currently, we only have notebooks in examples. We can create more standalone poetry projects as example where they also have a notebook and Google colab link. In this way, the user can quickly pick up the code. In addition to this, I can see that we can get more contributors; where they can add their idea as an example. Please note that, since each poetry project would be independent of the package, it can have other integrations such as mlflow, zenml, evidently, .... This would help us to see what we can infer out of the examples as new features inside the library itself. @Tsmith5151 I think you can start thinking about this pattern and moving the examples into their own projects. Something like:

examples/
         api/                   <- we move all of the current notebooks here as the pure examples of each module
         classification-with-mlflow-integration/ ....
         regression-with-zenml/ ... 
         timeseries-with-airflow/ ....

and so on; in this way we can add other dependencies to each example; Thoughts ?

Is your feature request related to a problem?

No response

Any other comments?

No response

amirhessam88 commented 2 years ago

@Tsmith5151 this is the placeholder to discuss examples/

amirhessam88 commented 2 years ago

@Tsmith5151 We also need to turn on Colab in notebooks. I did apply a restructure to the examples. Please take a look