Adjust architecture.md to display /training directory (#1079)

* adjust architecture.md to display /training directory * 🎨 Auto-generated directory tree for repository in Architecture.md --------- Co-authored-by: LuHG18 <[email protected]>
DSGT-DLP · Dec 29, 2023 · 3231870 · 3231870
1 parent 6c5593f
commit 3231870
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 38 deletions.
diff --git a/.github/Architecture.md b/.github/Architecture.md
@@ -1,47 +1,50 @@
 # Architecture
 
-## Backend Architecture
+## Training Architecture
 
 ```
-📦 backend
-|  |- 📂 ml:
+📦 training
+|  |- 📂 training:
+|  |  |- 📂 routes:
+|  |  |  |- 📂 datasets:
+|  |  |  |  |- 📂 default:
+|  |  |  |  |  |- 📜 columns.py
+|  |  |  |  |  |- 📜 __init__.py
+|  |  |  |  |  |- 📜 schemas.py
+|  |  |  |  |- 📜 __init__.py
+|  |  |  |- 📂 tabular:
+|  |  |  |  |- 📜 __init__.py
+|  |  |  |  |- 📜 tabular.py
+|  |  |  |  |- 📜 schemas.py
+|  |  |  |- 📂 image:
+|  |  |  |  |- 📜 image.py
+|  |  |  |  |- 📜 __init__.py
+|  |  |  |  |- 📜 schemas.py
+|  |  |  |- 📜 __init__.py
+|  |  |  |- 📜 schemas.py
+|  |  |- 📂 core:
+|  |  |  |- 📜 dataset.py : read in the dataset through URL or file upload
+|  |  |  |- 📜 __init__.py
+|  |  |  |- 📜 authenticator.py
+|  |  |  |- 📜 optimizer.py : what optimizer to use (ie: SGD or Adam for now)
+|  |  |  |- 📜 trainer.py
+|  |  |  |- 📜 dl_model.py : torch model based on user specifications from drag and drop
+|  |  |  |- 📜 criterion.py
+|  |  |- 📜 settings.py
+|  |  |- 📜 asgi.py
+|  |  |- 📜 wsgi.py
 |  |  |- 📜 __init__.py
-|  |  |- 📜 ml_model_parser.py
-|  |  |- 📜 ml_trainer.py : train a classical machine learning learning model on the dataset
-|  |- 📂 common:
-|  |  |- 📜 ai_drive.py
-|  |  |- 📜 preprocessing.py
-|  |  |- 📜 email_notifier.py : Endpoint to send email notification of training results via API Gateway + AWS SES
-|  |  |- 📜 default_datasets.py : store logic to load in default datasets from scikit-learn
-|  |  |- 📜 dataset.py : read in the dataset through URL or file upload
-|  |  |- 📜 constants.py : list of helpful constants
-|  |  |- 📜 utils.py : utility functions that could be helpful
-|  |  |- 📜 __init__.py
-|  |  |- 📜 loss_functions.py : loss function enum
-|  |  |- 📜 kernel.py
-|  |  |- 📜 optimizer.py : what optimizer to use (ie: SGD or Adam for now)
-|  |- 📂 dl:
-|  |  |- 📜 detection.py
-|  |  |- 📜 dl_model_parser.py : parse the user specified pytorch model
-|  |  |- 📜 dl_eval.py : Evaluation functions for deep learning models in Pytorch (eg: accuracy, loss, etc)
-|  |  |- 📜 __init__.py
-|  |  |- 📜 dl_model.py : torch model based on user specifications from drag and drop
-|  |  |- 📜 dl_trainer.py : train a deep learning model on the dataset
-|  |- 📂 aws_helpers:
-|  |  |- 📂 dynamo_db_utils:
-|  |  |  |- 📜 trainspace_db.py
-|  |  |  |- 📜 userprogress_db.py
-|  |  |  |- 📜 constants.py : list of helpful constants
-|  |  |  |- 📜 DynamoUnitTests.md
-|  |  |  |- 📜 dynamo_db_utils.py
-|  |  |- 📜 __init__.py
-|  |- 📜 app.py : run the backend (entrypoint script)
+|  |  |- 📜 urls.py
+|  |- 📜 environment.yml
 |  |- 📜 poetry.lock
-|  |- 📜 middleware.py
-|  |- 📜 __init__.py
-|  |- 📜 data.csv : data csv file for use in the playground
-|  |- 📜 epoch_times.csv
+|  |- 📜 manage.py
+|  |- 📜 docker-compose.yml
+|  |- 📜 cli.py
+|  |- 📜 docker-compose.prod.yml
+|  |- 📜 pytest.ini
 |  |- 📜 pyproject.toml
+|  |- 📜 README.md
+|  |- 📜 Dockerfile
 ```
 
 ## Frontend Architecture

diff --git a/file_tree_generator.py b/file_tree_generator.py
@@ -1,7 +1,7 @@
 import os
 import regex as re
 
-TARGET_DIRECTORIES = ["backend", "frontend"]
+TARGET_DIRECTORIES = ["training", "frontend"]
 
 # Content to ignore
 IGNORED_DIRECTORIES = [