Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jshtaway authored Feb 4, 2019
1 parent ee803e8 commit 6413ab9
Showing 1 changed file with 6 additions and 35 deletions.
41 changes: 6 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,58 +6,29 @@ This project focuses on using LSTM machine learning models to create Dr Seuss li

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
word_based.ipnb is our experimentation with word based LSTM models. This has the advantage of outputing only words that it has seen, and will therefore be more readable. However this makes for less training data availability than the character based model. Our character based model can be found in seuss.ipnb or seuss.py

### Prerequisites

The model is very big, and may require a dedicated GPU to run. AWS provides GPU's and can be experimented on with a free trial.
npm
You'll need:
npm, flask, and sufficient hardware for model utilization, or training should you want to play with the model.

## Running the tests

Explain how to run the automated tests for this system
The parameters of this model creation code are easily manipulatable for experiementation. When the code runs it will save model information, as well as training loss, accuracy and model output data in a json file for visibilty. You can see previous output files in AlldataX.json

### Break down into end to end tests

Explain what these tests test and why

```
Give an example
```

### And coding style tests

Explain what these tests test and why

```
Give an example
```

## Deployment

Add additional notes about how to deploy this on a live system

## Built With
* [Dedicated GOU] (https://aws.amazon.com/ec2/instance-types/p3/) - Or similar

## Contributing
* [Dedicated GPU] (https://aws.amazon.com/ec2/instance-types/p3/) - Or similar

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.

## Authors

* **Jennifer Shtaway** - *Model Training, web developement, graphical representations of results*
* **

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## Acknowledgments

* Hat tip to anyone whose code was used
* Inspiration
* etc
* Hat tip to my team, Vish, Greyson, and Alper who collaborated with me on this.

0 comments on commit 6413ab9

Please sign in to comment.