Merge pull request #11 from EddieCueto/documwork

Added README text
This commit is contained in:
Eduardo Cueto Mendoza 2020-07-05 19:32:09 -06:00 committed by GitHub
commit 36768c4016
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions

View File

@ -1,7 +1,19 @@
# GreenFlux
<p align="center">
<img width="400px" src="green-flux-logo.png"/>
</p>
[![Build Status](https://github.com/EddieCueto/GreenFlux.jl/workflows/CI/badge.svg)](https://github.com/EddieCueto/GreenFlux.jl/actions)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://EddieCueto.github.io/GreenFlux.jl/stable)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://EddieCueto.github.io/GreenFlux.jl/dev)
[![Build Status](https://travis-ci.com/EddieCueto/GreenFlux.jl.svg?branch=master)](https://travis-ci.com/EddieCueto/GreenFlux.jl)
[![Coverage](https://codecov.io/gh/EddieCueto/GreenFlux.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/EddieCueto/GreenFlux.jl)
<!-- [![Build Status](https://github.com/EddieCueto/GreenFlux.jl/workflows/CI/badge.svg)](https://github.com/EddieCueto/GreenFlux.jl/actions) -->
GreenFlux adds Green AI functionalities to [Flux](https://github.com/FluxML/Flux.jl) so you can make more precise reports on your peer reviewed papers or conference submissions of the electricity consumed by your model during training and number of `non-embedding Floating Point OPerations` that your Flux model will require during forward and back propagation.
To install just do:
```julia
] add GreenFlux
```
In the future I will add an expanded documentation.

BIN
green-flux-logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB