Skip to content

Commit

Permalink
💣🛠 moved notebooks under examples directory
Browse files Browse the repository at this point in the history
- jupyter notebooks are generally not a part of production code and thus moved under examples
- fix #4 updated howto.md
  • Loading branch information
ZenithClown committed Feb 21, 2024
1 parent 763f5a1 commit 1926908
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 8 deletions.
14 changes: 7 additions & 7 deletions HOWTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

<div align = "justify">

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
Expand All @@ -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
```

</div>
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

</div>
</div>
Empty file removed utilities/.gitkeep
Empty file.
10 changes: 10 additions & 0 deletions utilities/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<h1 align = "center">Utilities Module</div>

---

<div align = "justify">

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`.

</div>

0 comments on commit 1926908

Please sign in to comment.