Skip to content

Commit

Permalink
Update and rename README-Template.md to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jshtaway authored Feb 2, 2019
1 parent d50e953 commit 9914b18
Showing 1 changed file with 7 additions and 34 deletions.
41 changes: 7 additions & 34 deletions README-Template.md → README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,15 @@
# Project Title
# Dr-Suess Machine Learning LSTM

One Paragraph of project description goes here
This project focuses on using LSTM machine learning models to create Dr Seuss like stories from a user input seed.

## 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.

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```

### Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

End with an example of getting some data out of the system or using it for a little demo
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

## Running the tests

Expand All @@ -57,22 +36,16 @@ Give an example
Add additional notes about how to deploy this on a live system

## Built With

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
* [Dedicated GOU] (https://aws.amazon.com/ec2/instance-types/p3/) - Or similar

## Contributing

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.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).

## Authors

* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
* **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.

Expand Down

0 comments on commit 9914b18

Please sign in to comment.