Feyn Documentation

Feyn Documentation

  • Learn
  • Guides
  • Tutorials
  • API Reference
  • FAQ

›Getting Started

Getting Started

  • Quick start
  • Using Feyn
  • Installation
  • What is the QLattice?

Essentials

  • Auto Run
  • Summary plot
  • Plot response
  • Splitting a dataset
  • Seeding a QLattice
  • Predicting with a model
  • Saving and loading models
  • Categorical features

Evaluate Regressors

  • Regression plot
  • Residuals plot

Evaluate Classifiers

  • ROC curve
  • Confusion matrix
  • Plot probability scores

Understand Your Models

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

Primitive Operations

  • Using the primitives
  • Updating priors
  • Sample models
  • Fitting models
  • Pruning models
  • Visualise a model
  • Diverse models
  • Updating a QLattice
  • Validate data
  • Semantic types

Advanced

  • Converting a model to SymPy
  • Logging in Feyn
  • Setting themes
  • Saving a graph as an image
  • Using the query language
  • Estimating priors
  • Filtering models
  • Model parameters
  • Model complexity

Privacy & Commercial

  • Privacy
  • Community edition
  • Commercial use
  • Transition to Feyn 3.0

Installation

by: Kevin Broløs, Tom Jelen & Emil Larsen
(Feyn version 3.0 or newer)


Requirements

  • OS:
    • Debian-based Linux, Ubuntu 18.04+
    • macOS 10.14+
    • Windows
  • Python 3.8, 3.9, 3.10, 3.11 or 3.12

If you're using macOS on an 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 FeynWhat is the QLattice? →
  • Requirements
  • Installing Feyn
  • Upgrading Feyn
  • Deprecation of Feyn 2.x

Subscribe to get news about Feyn and the QLattice.

You can opt out at any time, and you can read our privacy policy here.

Copyright © 2024 Abzu.ai - Feyn license: CC BY-NC-ND 4.0
Feyn®, QGraph®, and the QLattice® are registered trademarks of Abzu®