Prepare for initial release

.github/workflows/CI.yml

@@ -0,0 +1,34 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version:
+          - 1.7
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+        with:
+          coverage: false

Project.toml

@@ -1,6 +1,6 @@
 name = "ExplicitFluxLayers"
 uuid = "aafdbc67-5cd5-409a-82a0-ebc47ac8091e"
-authors = ["Avik Pal <avikpal@iitk.ac.in> and contributors"]
+authors = ["Avik Pal <avikpal@mit.edu> and contributors"]
 version = "0.1.0"
 
 [deps]
@@ -13,6 +13,11 @@ Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [compat]
+CUDA = "3"
+ChainRulesCore = "1"
+Flux = "0.12"
+NNlib = "0.8"
+Setfield = "0.8"
 julia = "1"
 
 [extras]

README.md

@@ -1,6 +1,6 @@
 # ExplicitFluxLayers
 
-Flux by default relies on storing parameters and states in its model structs. `AbstractExplicitLayers` is an initial prototype
+Flux by default relies on storing parameters and states in its model structs. `ExplicitFluxLayers` is an initial prototype
 to make Flux explicit-parameter first.
 
 An `AbstractExplicitLayer` is simply the minimal set of fixed attributes required to define a layer, i.e. an `AbstractExplicitLayer` is
@@ -34,6 +34,12 @@ None of these attributes of BatchNorm change over time. Next each layer needs to
 Additionally each AbstractExplicitLayer must return a Tuple of length 2 with the first element being the computed result and the
 second element being the new state.
 
+## Installation
+
+```julia
+] add ExplicitFluxLayers
+```
+
 ## Usage
 
 ```julia
@@ -83,7 +89,7 @@ ps, st = ExplicitFluxLayers.setup(MersenneTwister(0), model)
 ExplicitFluxLayers.apply(model, x, ps, st)
 ```
 
-## Currently Implemented Explicit Layers (none of these are exported)
+## Implemented Layers
 
 These layers have the same API as their Flux counterparts.
 
@@ -95,3 +101,10 @@ These layers have the same API as their Flux counterparts.
 * `Parallel`
 * `SkipConnection`
 * `MaxPool`, `MeanPool`
+* `ReshapeLayer`, `SelectDim`, `FlattenLayer`, `NoOpLayer`, `WrappedFunction`
+
+## TODOs
+
+- [ ] Support Recurrent Neural Networks
+- [ ] Add wider support for Flux Layers
+- [ ] Port tests over from Flux