From 192690813560d166b6937fbea8c35b0e31f593d8 Mon Sep 17 00:00:00 2001 From: ZenithClown Date: Wed, 21 Feb 2024 21:50:04 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=A3=F0=9F=9B=A0=20moved=20notebooks=20?= =?UTF-8?q?under=20examples=20directory?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - jupyter notebooks are generally not a part of production code and thus moved under examples - fix #4 updated howto.md --- HOWTO.md | 14 +++++++------- {notebooks => examples}/BOILERPLATE.ipynb | 0 .../Time Series - BOILERPLATE.ipynb | 0 src/README.md | 2 +- utilities/.gitkeep | 0 utilities/README.md | 10 ++++++++++ 6 files changed, 18 insertions(+), 8 deletions(-) rename {notebooks => examples}/BOILERPLATE.ipynb (100%) rename {notebooks => examples}/Time Series - BOILERPLATE.ipynb (100%) delete mode 100644 utilities/.gitkeep create mode 100644 utilities/README.md diff --git a/HOWTO.md b/HOWTO.md index d4964e2..5d05767 100644 --- a/HOWTO.md +++ b/HOWTO.md @@ -2,19 +2,19 @@
-The template provides a minimal approach for getting started with an AI/ML project, and has hardly any dependencies required. However, the [`notebooks/BOILERPLATE.ipynb`](notebooks/BOILERPLATE.ipynb) provides popular import and its configurations (like `pandas`, `numpy`, `scikit-learn` and `tensorflow`). A high level directory overview is as follows: +The template provides a minimal approach for getting started with an AI/ML project, and has hardly any dependencies required. However, the [`examples/BOILERPLATE.ipynb`](examples/BOILERPLATE.ipynb) provides popular import and its configurations (like `pandas`, `numpy`, `scikit-learn` and `tensorflow`). A high level directory overview is as follows: ``` -├───config : store all configuration files +├───config : store all configuration files/functions │ ├───data : responsible for all data handling, or contains raw data │ └───processed : contains processed data (like combined/normalized dataframes, tables, etc.) │ ├───logs : repository to contain log files, can also be saved in `/path/to/directory` │ -├───notebooks : contains boilerplate notebook for EDA and quick data understanding/explanations +├───examples : contains boilerplate notebook for EDA and quick data understanding/explanations │ -├───output : directory responsible for all output files +├───output : directory responsible for all output files, useful for code development │ ├───images : save output images │ └───savedmodels : save trained model files │ @@ -25,10 +25,10 @@ The template provides a minimal approach for getting started with an AI/ML proje │ ├───static : other important/useful resources required in the project │ ├───fonts : store additional fonts, maybe used in documentations -│ ├───images : store explanatory images -│ └───logo : setup a project logo +│ ├───images : store explanatory images, maybe used in documentations and/or ipynb/markdowns +│ └───logo : setup a project logo, purely useful for front layer applications can be safely ignored │ -└───utilities : utilities directory containing functions and/or submodules +└───utilities : utilities directory containing functions and/or submodules, check readme for more information ```
diff --git a/notebooks/BOILERPLATE.ipynb b/examples/BOILERPLATE.ipynb similarity index 100% rename from notebooks/BOILERPLATE.ipynb rename to examples/BOILERPLATE.ipynb diff --git a/notebooks/Time Series - BOILERPLATE.ipynb b/examples/Time Series - BOILERPLATE.ipynb similarity index 100% rename from notebooks/Time Series - BOILERPLATE.ipynb rename to examples/Time Series - BOILERPLATE.ipynb diff --git a/src/README.md b/src/README.md index ebc7a57..454469c 100644 --- a/src/README.md +++ b/src/README.md @@ -4,4 +4,4 @@ A "_heart_" of any project is the `src` which contains the "source" files for the project. As a *production level* code template, the directory provides three important directories as follows (I) `agents` : typically contains agent definations for a RNN application; (II) `engine` : provides a suit of machine learning analytic functions to perform model training and analytics on your dataset without giving up end-to-end performance; and (III) `models` : typically contains model definations. - \ No newline at end of file + diff --git a/utilities/.gitkeep b/utilities/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/utilities/README.md b/utilities/README.md new file mode 100644 index 0000000..dc1eeb4 --- /dev/null +++ b/utilities/README.md @@ -0,0 +1,10 @@ +

Utilities Module + +--- + +
+ +Utility module containing useful additional libraries that either [I](https://zenithclown.github.io/) have created or sourced from different open-source +repositories. The actual submodules can either be added using [`git submodule`](https://git-scm.com/docs/git-submodule) or can be added to `PYTHONPATH`. + +