[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
[![Build Status](https://travis-ci.org/NeurX/neurx.svg?branch=master)](https://travis-ci.org/NeurX/neurx)
[![Coverage Status](https://coveralls.io/repos/github/NeurX/neurx/badge.svg?branch=master)](https://coveralls.io/github/NeurX/neurx?branch=master)

# Neurx

Neural network library for elixir.

### Testing

```bash
mix coveralls
```

## Defined Standards
- Keep the Changelog up to date and change version numbers accordingly
- Only public functions are documented with **@doc**
- If possible, provide an example usage in the @doc block
- Test everything.  We will know if coverage is missing.



## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `neurx` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:neurx, "~> 0.1.0"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/neurx_core](https://hexdocs.pm/neurx_core).