Skip to content

Commit

Permalink
Add upgrade note to README (#23)
Browse files Browse the repository at this point in the history
* Add upgrade note to README

requires beacon-biosignals/Legolas.jl#71; currently points to preview docs, but we should land that, then update the link here to point to dev or stable docs.

xref #21

* fix link
  • Loading branch information
ericphanson authored Nov 23, 2022
1 parent 53c6778 commit 9ee2257
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
[![CI](https://github.com/beacon-biosignals/LegolasFlux.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/beacon-biosignals/LegolasFlux.jl/actions/workflows/CI.yml)
[![codecov](https://codecov.io/gh/beacon-biosignals/LegolasFlux.jl/branch/main/graph/badge.svg?token=NHYUL22HCC)](https://codecov.io/gh/beacon-biosignals/LegolasFlux.jl)

### Note: Upgrading from LegolasFlux v0.1.x to v0.2?
The only change is an update to Legolas v0.5. Be sure to check out the [guidance for updating Legolas to v0.5](https://beacon-biosignals.github.io/Legolas.jl/dev/upgrade/) along with the rest of Legolas's documentation and tour.

---

LegolasFlux provides some simple functionality to use [Legolas.jl](https://github.com/beacon-biosignals/Legolas.jl/)'s
extensible Arrow schemas as means to serialize Flux models similarly to using Flux's `params` and `loadparams!`
(instead, we export similar functions `fetch_weights` and `load_weights!` which handle layers like `BatchNorm` correctly for this purpose).
Expand Down

0 comments on commit 9ee2257

Please sign in to comment.