docs: Update documentation files

This commit is contained in:
Ash
2025-10-28 19:33:54 +00:00
parent 46218890c5
commit 2c0706b70f
2 changed files with 13 additions and 12 deletions
+12 -11
View File
@@ -2,29 +2,30 @@
## Prerequisites
* MetaTrader 5 terminal installed.
* Python 3.x installed.
* The following Python libraries installed: `pandas`, `scikit-learn`, `skl2onnx`, `onnxruntime`.
* **MetaTrader 5 Terminal**: You need to have the MetaTrader 5 terminal installed. You can download it from the official website of your broker.
* **Python 3.x**: You need to have Python 3.x installed. You can download it from the official Python website.
* **Python Libraries**: You need to have the following Python libraries installed: `pandas`, `scikit-learn`, `skl2onnx`, `onnxruntime`.
## Installation
1. Clone the repository to your local machine.
2. Install the required Python libraries using pip:
1. **Clone the repository** to your local machine.
2. **Install the required Python libraries** using pip:
```bash
pip install pandas scikit-learn skl2onnx onnxruntime
pip install -r requirements.txt
```
## Running the project
1. **Export Price Data**:
* Open the MetaEditor in your MetaTrader 5 terminal.
* Open the `Export_EURUSD_History.mq5` file.
* Open the `Export_EURUSD_History.mq5` file from the `separate_codes` directory.
* Compile the script.
* Run the script on a EUR/USD chart. This will create a `raw_price_data.csv` file in the `MQL5/Files` directory of your MetaTrader 5 installation.
* Run the script on a EUR/USD chart. This will create a `raw_price_data.csv` file in the `MQL5/Files` directory of your MetaTrader 5 installation. The location of this directory can vary depending on your installation. You can find the location of the `MQL5` directory by going to `File > Open Data Folder` in your MetaTrader 5 terminal.
* Copy the `raw_price_data.csv` file to the root of the project directory.
2. **Train the Models**:
* Navigate to the `separate_codes` directory in your terminal.
* Run the `create_benchmark_model.py` script to create the benchmark model.
```bash
@@ -38,7 +39,7 @@
```
3. **Run the Expert Advisors**:
* Copy the `Benchmark_Model_EA.mq5` and `Neural_Network_Trader_EA.mq5` files to the `MQL5/Experts` directory of your MetaTrader 5 installation.
* Copy the `benchmark_logistic_model.onnx` and `trading_neural_network_model.onnx` files to the `MQL5/Files` directory of your MetaTrader 5 installation.
* Copy the `Benchmark_Model_EA.mq5` and `Neural_Network_Trader_EA.mq5` files from the `separate_codes` directory to the `MQL5/Experts` directory of your MetaTrader 5 installation.
* Copy the `benchmark_logistic_model.onnx` and `trading_neural_network_model.onnx` files from the `separate_codes` directory to the `MQL5/Files` directory of your MetaTrader 5 installation.
* Open the MetaEditor and compile the EAs.
* Attach the EAs to a EUR/USD chart in your MetaTrader 5 terminal.
* Attach the EAs to a EUR/USD chart in your MetaTrader 5 terminal.