From b064dac997ff4473ba1ae8fa2a929f193051611c Mon Sep 17 00:00:00 2001
From: Chris Wong <chriswcy@gmail.com>
Date: Tue, 30 May 2023 01:47:29 +0800
Subject: [PATCH] Update the structure of "README.md"

---
 README.md | 122 +++++++++++++++++++++++++++---------------------------
 1 file changed, 61 insertions(+), 61 deletions(-)

diff --git a/README.md b/README.md
index fe114ce..3d224f3 100644
--- a/README.md
+++ b/README.md
@@ -9,64 +9,64 @@ This project is an automatic trading system based on a Transformer and Reinforce
 
 ## Structure
 
-my_project/
-│
-├── data/
-│ ├── raw/ # Raw data goes here
-│ └── processed/ # Processed data goes here
-│
-├── notebooks/ # Jupyter notebooks for exploratory analysis and prototyping
-│ ├── data_exploration.ipynb # Notebook for exploring the data
-│ ├── data_preprocessing.ipynb # Notebook for preprocessing the data
-│ ├── model_prototyping.ipynb # Notebook for prototyping models
-│ ├── model_training.ipynb # Notebook for training models
-│ ├── model_evaluation.ipynb # Notebook for evaluating models
-│ └── hyperparameter_tuning.ipynb # Notebook for tuning hyperparameters
-│
-├── src/
-│ ├── agents/ # Agents module for HuggingFace's Transformers
-│ │ ├── init.py
-│ │ └── agent_example.py # An example of a Transformer Agent
-│ │
-│ ├── data/ # Data handling module
-│ │ ├── init.py
-│ │ ├── data_collection.py # Data collection scripts
-│ │ └── data_preprocessing.py # Data preprocessing scripts
-│ │
-│ ├── models/ # Models module
-│ │ ├── init.py
-│ │ ├── transformer_model.py # Transformer model script
-│ │ ├── rl_model.py # RL model script
-│ │ └── trading_model.py # Trading model script
-│ │
-│ ├── training/ # Training module
-│ │ ├── init.py
-│ │ └── train.py # Training scripts
-│ │
-│ ├── evaluation/ # Evaluation module
-│ │ ├── init.py
-│ │ └── evaluate.py # Evaluation scripts
-│ │
-│ ├── utils/ # Utility module
-│ │ ├── init.py
-│ │ ├── utils.py # Utility scripts (including seeding function)
-│ │ └── metrics.py # Metrics computation scripts
-│ │
-│ └── main.py # Main script to run the model
-│
-├── config/ # Configuration files
-│ ├── transformer.json
-│ ├── rl.json
-│ └── training.json
-│
-├── tests/ # Test module
-│ ├── init.py
-│ ├── test_data.py # Tests for data collection and preprocessing
-│ ├── test_models.py # Tests for model creation
-│ ├── test_training.py # Tests for model training
-│ ├── test_evaluation.py # Tests for model evaluation
-│ └── test_utils.py # Tests for utility functions
-│
-├── .gitignore # Specifies which files should be ignored by Git
-├── README.md # Project description and instructions
-└── requirements.txt # List of Python dependencies
+my_project/<br />
+│<br />
+├── data/<br />
+│ ├── raw/ # Raw data goes here<br />
+│ └── processed/ # Processed data goes here<br />
+│<br />
+├── notebooks/ # Jupyter notebooks for exploratory analysis and prototyping<br />
+│ ├── data_exploration.ipynb # Notebook for exploring the data<br />
+│ ├── data_preprocessing.ipynb # Notebook for preprocessing the data<br />
+│ ├── model_prototyping.ipynb # Notebook for prototyping models<br />
+│ ├── model_training.ipynb # Notebook for training models<br />
+│ ├── model_evaluation.ipynb # Notebook for evaluating models<br />
+│ └── hyperparameter_tuning.ipynb # Notebook for tuning hyperparameters<br />
+│<br />
+├── src/<br />
+│ ├── agents/ # Agents module for HuggingFace's Transformers<br />
+│ │ ├── init.py<br />
+│ │ └── agent_example.py # An example of a Transformer Agent<br />
+│ │<br />
+│ ├── data/ # Data handling module<br />
+│ │ ├── init.py<br />
+│ │ ├── data_collection.py # Data collection scripts<br />
+│ │ └── data_preprocessing.py # Data preprocessing scripts<br />
+│ │<br />
+│ ├── models/ # Models module<br />
+│ │ ├── init.py<br />
+│ │ ├── transformer_model.py # Transformer model script<br />
+│ │ ├── rl_model.py # RL model script<br />
+│ │ └── trading_model.py # Trading model script<br />
+│ │<br />
+│ ├── training/ # Training module<br />
+│ │ ├── init.py<br />
+│ │ └── train.py # Training scripts<br />
+│ │<br />
+│ ├── evaluation/ # Evaluation module<br />
+│ │ ├── init.py<br />
+│ │ └── evaluate.py # Evaluation scripts<br />
+│ │<br />
+│ ├── utils/ # Utility module<br />
+│ │ ├── init.py<br />
+│ │ ├── utils.py # Utility scripts (including seeding function)<br />
+│ │ └── metrics.py # Metrics computation scripts<br />
+│ │<br />
+│ └── main.py # Main script to run the model<br />
+│<br />
+├── config/ # Configuration files<br />
+│ ├── transformer.json<br />
+│ ├── rl.json<br />
+│ └── training.json<br />
+│<br />
+├── tests/ # Test module<br />
+│ ├── init.py<br />
+│ ├── test_data.py # Tests for data collection and preprocessing<br />
+│ ├── test_models.py # Tests for model creation<br />
+│ ├── test_training.py # Tests for model training<br />
+│ ├── test_evaluation.py # Tests for model evaluation<br />
+│ └── test_utils.py # Tests for utility functions<br />
+│<br />
+├── .gitignore # Specifies which files should be ignored by Git<br />
+├── README.md # Project description and instructions<br />
+└── requirements.txt # List of Python dependencies<br />