Updated README.md

README.md

@@ -1,72 +1,74 @@
 # AutoTradingSystem
 
-This project is an automatic trading system based on a Transformer and Reinforcement Learning hybrid model. It is built using HuggingFace's Transformers library and ChatGPT-4.
+Trial project for deep learning trading model with ChatGPT-4
+
+This project is an automatic trading system based on a Transformer and Reinforcement Learning hybrid model.
 
 ## Setup
 
-1. Install the required packages: `pip install -r requirements.txt`
+1. Install the required packages: `pip install -r requirements.txt`  
 2. Run the main script: `python src/main.py`
 
 ## Structure
 
-my_project/<br />
+my_project/  
-│<br />
+│  
-├── data/<br />
+├── data/  
-│ ├── raw/ # Raw data goes here<br />
+│   ├── raw/                   # Raw data goes here  
-│ └── processed/ # Processed data goes here<br />
+│   └── processed/             # Processed data goes here  
-│<br />
+│  
-├── notebooks/ # Jupyter notebooks for exploratory analysis and prototyping<br />
+├── notebooks/                 # Jupyter notebooks for exploratory analysis and prototyping  
-│ ├── data_exploration.ipynb # Notebook for exploring the data<br />
+│   ├── data_exploration.ipynb  
-│ ├── data_preprocessing.ipynb # Notebook for preprocessing the data<br />
+│   ├── data_preprocessing.ipynb  
-│ ├── model_prototyping.ipynb # Notebook for prototyping models<br />
+│   ├── model_prototyping.ipynb  
-│ ├── model_training.ipynb # Notebook for training models<br />
+│   ├── model_training.ipynb  
-│ ├── model_evaluation.ipynb # Notebook for evaluating models<br />
+│   ├── hyperparameter_tuning.ipynb  
-│ └── hyperparameter_tuning.ipynb # Notebook for tuning hyperparameters<br />
+│   └── model_evaluation.ipynb  
-│<br />
+│  
-├── src/<br />
+├── src/  
-│ ├── agents/ # Agents module for HuggingFace's Transformers<br />
+│   ├── agents/                # Agents module for HuggingFace's Transformers  
-│ │ ├── init.py<br />
+│   │   ├── \_\_init\_\_.py  
-│ │ └── agent_example.py # An example of a Transformer Agent<br />
+│   │   └── agent_example.py   # An example of a Transformer Agent  
-│ │<br />
+│   │  
-│ ├── data/ # Data handling module<br />
+│   ├── data/                  # Data handling module  
-│ │ ├── init.py<br />
+│   │   ├── \_\_init\_\_.py  
-│ │ ├── data_collection.py # Data collection scripts<br />
+│   │   ├── data_collection.py # Data collection scripts  
-│ │ └── data_preprocessing.py # Data preprocessing scripts<br />
+│   │   └── data_preprocessing.py # Data preprocessing scripts  
-│ │<br />
+│   │  
-│ ├── models/ # Models module<br />
+│   ├── models/                # Models module  
-│ │ ├── init.py<br />
+│   │   ├── \_\_init\_\_.py  
-│ │ ├── transformer_model.py # Transformer model script<br />
+│   │   ├── transformer_model.py # Transformer model script  
-│ │ ├── rl_model.py # RL model script<br />
+│   │   ├── rl_model.py         # RL model script  
-│ │ └── trading_model.py # Trading model script<br />
+│   │   └── trading_model.py    # Trading model script  
-│ │<br />
+│   │  
-│ ├── training/ # Training module<br />
+│   ├── training/              # Training module  
-│ │ ├── init.py<br />
+│   │   ├── \_\_init\_\_.py  
-│ │ └── train.py # Training scripts<br />
+│   │   └── train.py            # Training scripts  
-│ │<br />
+│   │  
-│ ├── evaluation/ # Evaluation module<br />
+│   ├── evaluation/            # Evaluation module  
-│ │ ├── init.py<br />
+│   │   ├── \_\_init\_\_.py  
-│ │ └── evaluate.py # Evaluation scripts<br />
+│   │   └── evaluate.py         # Evaluation scripts  
-│ │<br />
+│   │  
-│ ├── utils/ # Utility module<br />
+│   ├── utils/                 # Utility module  
-│ │ ├── init.py<br />
+│   │   ├── \_\_init\_\_.py  
-│ │ ├── utils.py # Utility scripts (including seeding function)<br />
+│   │   ├── utils.py            # Utility scripts (including seeding function)  
-│ │ └── metrics.py # Metrics computation scripts<br />
+│   │   └── metrics.py          # Metrics computation scripts  
-│ │<br />
+│   │  
-│ └── main.py # Main script to run the model<br />
+│   └── main.py                # Main script to run the model  
-│<br />
+│  
-├── config/ # Configuration files<br />
+├── config/                    # Configuration files  
-│ ├── transformer.json<br />
+│   ├── transformer.json  
-│ ├── rl.json<br />
+│   ├── rl.json  
-│ └── training.json<br />
+│   └── training.json  
-│<br />
+│  
-├── tests/ # Test module<br />
+├── tests/                     # Test module  
-│ ├── init.py<br />
+│   ├── \_\_init\_\_.py  
-│ ├── test_data.py # Tests for data collection and preprocessing<br />
+│   ├── test_data.py           # Tests for data collection and preprocessing  
-│ ├── test_models.py # Tests for model creation<br />
+│   ├── test_models.py         # Tests for model creation  
-│ ├── test_training.py # Tests for model training<br />
+│   ├── test_training.py       # Tests for model training  
-│ ├── test_evaluation.py # Tests for model evaluation<br />
+│   ├── test_evaluation.py     # Tests for model evaluation  
-│ └── test_utils.py # Tests for utility functions<br />
+│   └── test_utils.py          # Tests for utility functions  
-│<br />
+│  
-├── .gitignore # Specifies which files should be ignored by Git<br />
+├── .gitignore                 # Specifies which files should be ignored by Git  
-├── README.md # Project description and instructions<br />
+├── README.md                  # Project description and instructions  
-└── requirements.txt # List of Python dependencies<br />
+└── requirements.txt           # List of Python dependencies