refactor: Modify package structure (#48)

* refactor: Modify package structure * refactor: Modify package structure * refactor: Modify package structure
aaivu · May 12, 2024 · b183fc1 · b183fc1
1 parent ead11ee
commit b183fc1
Show file tree

Hide file tree

Showing 40 changed files with 19 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,25 @@
 <p align="center">
-    <img height="238" src="./docs/images/logo-1.png" alt="ibat_logo">
+    <img height="238" src="./asserts/images/logo-1.png" alt="ibat_logo">
 </p>
 
 <p align="center">
-    <img src="https://img.shields.io/badge/-Project-blue" alt="project">
-    <img src="https://img.shields.io/badge/-Research-yellowgreen" alt="research">
+    <b>iBAT</b> is a Python framework to enhance the real-time bus arrival/dwell time prediction in heterogenous traffic condition by addressing concept drift.
 </p>
+
+[//]: # (<p align="center">)
+
+[//]: # (    <img src="https://img.shields.io/badge/-Project-blue" alt="project">)
+
+[//]: # (    <img src="https://img.shields.io/badge/-Research-yellowgreen" alt="research">)
+
+[//]: # (</p>)
+
 <p align="center">
-    <img src="https://img.shields.io/badge/Bus%20arrival%20time%20prediction-8A2BE2" alt="batpre">
+    <img src="https://img.shields.io/badge/Bus%20arrival/dwell%20time%20prediction-8A2BE2" alt="batpre">
     <img src="https://img.shields.io/badge/Hybrid%20batch%20processing-8A2BE2" alt="hbp">
     <img src="https://img.shields.io/badge/Concept%20drift%20handling-8A2BE2" alt="cdrift">
     <img src="https://img.shields.io/badge/Active%20strategy-8A2BE2" alt="active">
-    <img src="https://img.shields.io/badge/Incremental%20online%20learning-8A2BE2" alt="iol">
+    <img src="https://img.shields.io/badge/Incremental%20learning-8A2BE2" alt="iol">
 </p>
 <p align="center">
     <!-- PyPI -->
@@ -20,22 +28,18 @@
     </a>
     <!-- PePy -->
     <a href="https://pepy.tech/project/gps2gtfs">
-        <img src="https://static.pepy.tech/badge/gps2gtfs?label=PyPI%20downloads&style=flat-square" alt="pepy">
+        <img src="https://static.pepy.tech/badge/gps2gtfs?label=PyPI%20downloads&color=blue&style=flat-square" alt="pepy">
     </a>
     <!-- Black -->
     <a href="https://github.com/psf/black">
-        <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="black">
+        <img src="https://img.shields.io/badge/code%20style-black-000000.svg?color=blue" alt="black">
     </a>
     <!-- License -->
     <a href="https://opensource.org/licenses/BSD-3-Clause">
         <img src="https://img.shields.io/badge/License-BSD%203--Clause-blue.svg?style=flat-square" alt="bsd_3_license">
     </a>
 </p>
 
-<p align="center">
-    <b>iBAT</b> is a Python framework to enhance the real-time bus arrival time prediction in heterogenous traffic condition by addressing concept drift.
-</p>
-
 ## Description
 
 <p align="justify">
@@ -45,7 +49,7 @@
 ## Architecture
 
 <p align="center">
-    <img src="./docs/images/archi-dig.png" alt="archi-dig">
+    <img src="./asserts/images/archi-dig.png" alt="archi-dig">
 </p>
 
 ## 🛠 Installation

diff --git a/docs/MME4BAT/.gitignore → asserts/MME4BAT/.gitignore b/docs/MME4BAT/.gitignore → asserts/MME4BAT/.gitignore
diff --git a/docs/MME4BAT/LICENSE → asserts/MME4BAT/LICENSE b/docs/MME4BAT/LICENSE → asserts/MME4BAT/LICENSE
diff --git a/docs/MME4BAT/README.md → asserts/MME4BAT/README.md b/docs/MME4BAT/README.md → asserts/MME4BAT/README.md
diff --git a/docs/MME4BAT/convlstm.py → asserts/MME4BAT/convlstm.py b/docs/MME4BAT/convlstm.py → asserts/MME4BAT/convlstm.py
diff --git a/docs/MME4BAT/docs/README.md → asserts/MME4BAT/docs/README.md b/docs/MME4BAT/docs/README.md → asserts/MME4BAT/docs/README.md
diff --git a/docs/MME4BAT/dwelltime_classification.py → asserts/MME4BAT/dwelltime_classification.py b/docs/MME4BAT/dwelltime_classification.py → asserts/MME4BAT/dwelltime_classification.py
diff --git a/docs/MME4BAT/error_analysis.py → asserts/MME4BAT/error_analysis.py b/docs/MME4BAT/error_analysis.py → asserts/MME4BAT/error_analysis.py
diff --git a/docs/MME4BAT/feature_engineering.py → asserts/MME4BAT/feature_engineering.py b/docs/MME4BAT/feature_engineering.py → asserts/MME4BAT/feature_engineering.py
diff --git a/...AT/hyperparameter_tuning_and_comparing.py → ...AT/hyperparameter_tuning_and_comparing.py b/...AT/hyperparameter_tuning_and_comparing.py → ...AT/hyperparameter_tuning_and_comparing.py
diff --git a/docs/MME4BAT/multimodel.py → asserts/MME4BAT/multimodel.py b/docs/MME4BAT/multimodel.py → asserts/MME4BAT/multimodel.py
diff --git a/docs/MME4BAT/outlier_capping.py → asserts/MME4BAT/outlier_capping.py b/docs/MME4BAT/outlier_capping.py → asserts/MME4BAT/outlier_capping.py
diff --git a/...efactoring_code/01-feature_engineering.py → ...efactoring_code/01-feature_engineering.py b/...efactoring_code/01-feature_engineering.py → ...efactoring_code/01-feature_engineering.py
diff --git a/...AT/refactoring_code/02-outlier_capping.py → ...AT/refactoring_code/02-outlier_capping.py b/...AT/refactoring_code/02-outlier_capping.py → ...AT/refactoring_code/02-outlier_capping.py
diff --git a/...oring_code/03-dwelltime_classification.py → ...oring_code/03-dwelltime_classification.py b/...oring_code/03-dwelltime_classification.py → ...oring_code/03-dwelltime_classification.py
diff --git a/docs/MME4BAT/refactoring_code/Untitled.ipynb → ...s/MME4BAT/refactoring_code/Untitled.ipynb b/docs/MME4BAT/refactoring_code/Untitled.ipynb → ...s/MME4BAT/refactoring_code/Untitled.ipynb
diff --git a/docs/MME4BAT/refactoring_code/convlstm.py → asserts/MME4BAT/refactoring_code/convlstm.py b/docs/MME4BAT/refactoring_code/convlstm.py → asserts/MME4BAT/refactoring_code/convlstm.py
diff --git a/...ctoring_code/data/bus_dwell_times_654.csv → ...ctoring_code/data/bus_dwell_times_654.csv b/...ctoring_code/data/bus_dwell_times_654.csv → ...ctoring_code/data/bus_dwell_times_654.csv
diff --git a/...oring_code/data/bus_running_times_654.csv → ...oring_code/data/bus_running_times_654.csv b/...oring_code/data/bus_running_times_654.csv → ...oring_code/data/bus_running_times_654.csv
diff --git a/...data/bus_stop_times_feature_added_all.csv → ...data/bus_stop_times_feature_added_all.csv b/...data/bus_stop_times_feature_added_all.csv → ...data/bus_stop_times_feature_added_all.csv
diff --git a/...data/bus_stop_times_feature_added_new.csv → ...data/bus_stop_times_feature_added_new.csv b/...data/bus_stop_times_feature_added_new.csv → ...data/bus_stop_times_feature_added_new.csv
diff --git a/...code/data/bus_stops_and_terminals_654.csv → ...code/data/bus_stops_and_terminals_654.csv b/...code/data/bus_stops_and_terminals_654.csv → ...code/data/bus_stops_and_terminals_654.csv
diff --git a/...T/refactoring_code/data/bus_trips_654.csv → ...T/refactoring_code/data/bus_trips_654.csv b/...T/refactoring_code/data/bus_trips_654.csv → ...T/refactoring_code/data/bus_trips_654.csv
diff --git a/docs/MME4BAT/src/README.md → asserts/MME4BAT/src/README.md b/docs/MME4BAT/src/README.md → asserts/MME4BAT/src/README.md
diff --git a/docs/asserts/README-1.md → asserts/_asserts/README-1.md b/docs/asserts/README-1.md → asserts/_asserts/README-1.md
diff --git a/docs/asserts/README-2.md → asserts/_asserts/README-2.md b/docs/asserts/README-2.md → asserts/_asserts/README-2.md
diff --git a/docs/asserts/del.csv → asserts/_asserts/del.csv b/docs/asserts/del.csv → asserts/_asserts/del.csv
diff --git a/docs/asserts/dt.png → asserts/_asserts/dt.png b/docs/asserts/dt.png → asserts/_asserts/dt.png
diff --git a/docs/datasets/WMT/WMT_2006_2018.csv → asserts/datasets/WMT/WMT_2006_2018.csv b/docs/datasets/WMT/WMT_2006_2018.csv → asserts/datasets/WMT/WMT_2006_2018.csv
diff --git a/docs/datasets/WMT/WMT_2006_2018.png → asserts/datasets/WMT/WMT_2006_2018.png b/docs/datasets/WMT/WMT_2006_2018.png → asserts/datasets/WMT/WMT_2006_2018.png
diff --git a/docs/datasets/input.csv → asserts/datasets/input.csv b/docs/datasets/input.csv → asserts/datasets/input.csv
diff --git a/asserts/images/archi-dig-1.png b/asserts/images/archi-dig-1.png
diff --git a/docs/images/archi-dig.png → asserts/images/archi-dig-2.png b/docs/images/archi-dig.png → asserts/images/archi-dig-2.png
diff --git a/asserts/images/archi-dig.png b/asserts/images/archi-dig.png
diff --git a/docs/images/logo-1.png → asserts/images/logo-1.png b/docs/images/logo-1.png → asserts/images/logo-1.png
diff --git a/docs/images/logo-2.png → asserts/images/logo-2.png b/docs/images/logo-2.png → asserts/images/logo-2.png
diff --git a/docs/images/logo-3.png → asserts/images/logo-3.png b/docs/images/logo-3.png → asserts/images/logo-3.png
diff --git a/examples/concept_drift_detector/adwin.py b/examples/concept_drift_detector/adwin.py
@@ -4,7 +4,7 @@
 from src.concept_drift_detector.strategies import ADWIN
 
 
-sorted_mean_arrival_time = pd.read_csv("../../docs/datasets/input.csv")
+sorted_mean_arrival_time = pd.read_csv("../../asserts/datasets/input.csv")
 
 stream = np.array(list(sorted_mean_arrival_time["arrival_time_in_seconds"]))
 

diff --git a/examples/concept_drift_detector/ddm.py b/examples/concept_drift_detector/ddm.py
@@ -17,7 +17,7 @@ def split_train_test(split_date, df):
     return before_missing_dates, after_missing_dates
 
 
-sorted_mean_arrival_time = pd.read_csv("../../docs/datasets/input.csv")
+sorted_mean_arrival_time = pd.read_csv("../../asserts/datasets/input.csv")
 
 train, test = split_train_test("2022-03-01", sorted_mean_arrival_time)
 

diff --git a/examples/concept_drift_detector/page_hinkley.py b/examples/concept_drift_detector/page_hinkley.py
@@ -4,7 +4,7 @@
 from src.concept_drift_detector.strategies import PageHinkley
 
 
-sorted_mean_arrival_time = pd.read_csv("../../docs/datasets/input.csv")
+sorted_mean_arrival_time = pd.read_csv("../../asserts/datasets/input.csv")
 
 stream = np.array(list(sorted_mean_arrival_time["arrival_time_in_seconds"]))