Feyn

Feyn

  • Tutorials
  • Guides
  • API Reference
  • FAQ

›Getting Started

Getting Started

  • Quick start
  • Using Feyn
  • Installation
  • Transition to Feyn 3.0
  • What is a QLattice?
  • Community edition
  • Commercial use

Essentials

  • Auto Run
  • Visualise a model
  • Summary plot
  • Semantic types
  • Categorical features
  • Estimating priors
  • Model parameters
  • Predicting with a model
  • Saving and loading models
  • Filtering models
  • Seeding a QLattice
  • Privacy

Evaluate Regressors

  • Regression plot
  • Residuals plot

Evaluate Classifiers

  • ROC curve
  • Confusion matrix
  • Plot probability scores

Understand Your Models

  • Plot response
  • Plot response 2D
  • Model signal
  • Segmented loss
  • Interactive flow

Primitive Operations

  • Using the primitives
  • Updating priors
  • Sample models
  • Fitting models
  • Pruning models
  • Diverse models
  • Updating a QLattice
  • Validate data

Advanced

  • Converting a model to SymPy
  • Setting themes
  • Saving a graph as an image
  • Using the query language
  • Model complexity

Installation

by: Tom Jelen & Emil Larsen
(Feyn version 3.0 or newer)

Requirements

  • OS:
    • Debian-based Linux, Ubuntu 18.04+
    • Mac OS X 10.14+
    • Windows
  • Python 3.7, 3.8, 3.9 or 3.10

If you're on an M1 (Apple Silicon) machine, you need macOS 12+ in order to satisfy a dependency on scikit-learn.

Installing Feyn

Feyn is available as Python package through pip.

You can install it with the following command:

richard@feyn:~$ pip3 install feyn

Upgrading Feyn

You can upgrade your version of Feyn if you already have it installed using

richard@feyn:~$ pip3 install feyn --upgrade

Deprecation of Feyn 2.x

Versions of Feyn below 3.0 will become deprecated in the near future. In order to keep using Feyn, please upgrade to Feyn 3.0 at your earliest convenience. See more about transitioning to Feyn 3.0 on this page

← Using FeynTransition to Feyn 3.0 →
  • Requirements
  • Installing Feyn
  • Upgrading Feyn
  • Deprecation of Feyn 2.x
Copyright © 2022 Abzu.ai
Feyn®, QGraph®, and the QLattice® are registered trademarks of Abzu®