vvzvlad/allora
1
0
Fork 0
Code Pull Requests Packages Releases Activity

Merge pull request #21 from Radovenchyk/patch-1

Browse Source 
Fix typo update README
This commit is contained in:
Clement 2024-09-05 18:21:17 +02:00 committed by GitHub
commit 820bfcc479
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -26,7 +26,7 @@ A complete working example is provided in the `docker-compose.yml` file.
Here are the currently accepted configurations: Here are the currently accepted configurations:
- TOKEN - TOKEN
Must be one in ['ETH','SOL','BTC','BNB','ARB']. Must be one in ('ETH','SOL','BTC','BNB','ARB').
Note: if you are using `Binance` as the data provider, any token could be used. Note: if you are using `Binance` as the data provider, any token could be used.
If you are using Coingecko, you should add its `coin_id` in the [token_map here](https://github.com/allora-network/basic-coin-prediction-node/blob/main/updater.py#L107). Find [more info here](https://docs.coingecko.com/reference/simple-price) and the [list here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing). If you are using Coingecko, you should add its `coin_id` in the [token_map here](https://github.com/allora-network/basic-coin-prediction-node/blob/main/updater.py#L107). Find [more info here](https://docs.coingecko.com/reference/simple-price) and the [list here](https://docs.google.com/spreadsheets/d/1wTTuxXt8n9q7C4NDXqQpI3wpKu1_5bGVmP9Xz0XGSyU/edit?usp=sharing).
- TRAINING_DAYS - TRAINING_DAYS
@ -39,7 +39,7 @@ A complete working example is provided in the `docker-compose.yml` file.
- TIMEFRAME >= 4h if TRAINING_DAYS <= 30 - TIMEFRAME >= 4h if TRAINING_DAYS <= 30
- TIMEFRAME >= 4d if TRAINING_DAYS >= 31 - TIMEFRAME >= 4d if TRAINING_DAYS >= 31
- MODEL - MODEL
Must be one in ['LinearRegression','SVR','KernelRidge','BayesianRidge']. Must be one in ('LinearRegression','SVR','KernelRidge','BayesianRidge').
You can easily add support for any other models by [adding it here](https://github.com/allora-network/basic-coin-prediction-node/blob/main/model.py#L133). You can easily add support for any other models by [adding it here](https://github.com/allora-network/basic-coin-prediction-node/blob/main/model.py#L133).
- REGION - REGION
Used for the Binance API. This should be in this form: `US`, `EU`, etc. Used for the Binance API. This should be in this form: `US`, `EU`, etc.