https://github.com/beacon-biosignals/lighthouseflux.jl

An adapter package that implements Lighthouse's framework interface for Flux
https://github.com/beacon-biosignals/lighthouseflux.jl

Last synced: 4 months ago
JSON representation

An adapter package that implements Lighthouse's framework interface for Flux

• Host: GitHub
• URL: https://github.com/beacon-biosignals/lighthouseflux.jl
• Owner: beacon-biosignals
• License: mit
• Created: 2020-02-11T19:24:02.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T00:20:09.000Z (over 1 year ago)
• Last Synced: 2024-04-01T01:28:33.650Z (over 1 year ago)
• Language: Julia
• Size: 332 KB
• Stars: 1
• Watchers: 22
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LighthouseFlux.jl

[![CI](https://github.com/beacon-biosignals/LighthouseFlux.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/beacon-biosignals/LighthouseFlux.jl/actions/workflows/CI.yml)

[![codecov](https://codecov.io/gh/beacon-biosignals/LighthouseFlux.jl/branch/main/graph/badge.svg?token=aOni8ATb88)](https://codecov.io/gh/beacon-biosignals/LighthouseFlux.jl)

[![Docs: stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://beacon-biosignals.github.io/LighthouseFlux.jl/stable)

[![Docs: development](https://img.shields.io/badge/docs-dev-blue.svg)](https://beacon-biosignals.github.io/LighthouseFlux.jl/dev)

LighthouseFlux provides a `FluxClassifier` wrapper that implements the [Lighthouse](https://github.com/beacon-biosignals/Lighthouse.jl) `AbstractClassifier` interface, thus enabling Flux models to easily utilize Lighthouse's training/testing harness. Assuming your model obeys normal Flux model conventions, hooking it up to LighthouseFlux generally only requires a single method overload (`LighthouseFlux.loss`).

See this package's tests for example usage.

## Installation

To install LighthouseFlux for development, run:

```

julia -e 'using Pkg; Pkg.develop(PackageSpec(url="https://github.com/beacon-biosignals/LighthouseFlux.jl"))'

```

This will install LighthouseFlux to the default package development directory, `~/.julia/dev/LighthouseFlux`.