search

amplabs-ai / amplabs

AmpLabs helps teams build better batteries.
https://amplabs.ai
9 stars 9 forks source link

Organize the /python folder #24

Open pghege opened 1 year ago

pghege commented 1 year ago

Within the /python folder, there needs to be some natural organization. Perhaps number each example based on order that a new user should complete them i.e. 01_Basics 02_Fetching_Data 03_Uploading_Data

In addition, a readme describing how a user should interact with the repo will be very useful to guide someone to the proper location.

The examples themselves should be ipython/jupyter notebooks that can open into a Colab document such that a new user can run them without downloading anything.

The notebooks should be self-explanatory with documentation blocks living alongside code blocks.

wehuang16 commented 1 year ago

@pghege I added more details on the Python examples "readme.md" and created a new merge request.