Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
driemworks committed Dec 30, 2018
1 parent 5343f1c commit d9eabad
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ Probably not.
## How it works
Mynt uses an LSTM network to predict close prices for a user-specified number of days in the future. The training data is downloaded via [Alpha Vantage](https://www.alphavantage.co/).

## Installation
Clone this repository. Inside the Mynt folder, create the mynt package using
``` python
python setup.py distutils
```
Then install using pip. If you are using windows
``` python
pip install ./dist/Mynt-1.0-dev.zip
```
If you are using a unix based OS
``` python
pip install ./dist/Mynt-1.0-dev.tar.gz
```

## Usage
First get an API key from Alpha Vantage.
To train a model for a particular ticker, use
Expand Down

0 comments on commit d9eabad

Please sign in to comment.