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

Transition to Feyn 3.0

by: Chris Cave
(Feyn version 3.0 or newer)

With Feyn 3.0, a remote QLattice is no longer required. This release allows you to run 100% locally on your own computer using the improved, lighter, QLattice. This change improves all our user's experiences, and it especially benefits our academic researchers and users with highly-sensitive data. This is an important step in our ongoing quest of creating a new class of trustworthy AI that prioritizes privacy.

Code written in Feyn 2.x is compatible with Feyn 3.0 so the transition will be as easy as running

pip3 install feyn --upgrade

Some functions are deprecated and will produce warnings.

Changes

The main change that you will experience when using Feyn 3.0. is that instead of connecting to a QLattice you instantiate it.

ql = feyn.QLattice()

You no longer use the reset function to seed the QLattice. Instead, if you want reproducible results you should seed the QLattice when you instantiate it. Like this:

ql = feyn.QLattice(random_seed=42)

Except for these changes you can treat the QLattice object just as you did in previous versions of Feyn.

If you try to connect to a QLattice with connect_qlattice() you will be met with a deprecation warning and that you should use feyn.QLattice().

Community QLattices

QLattices are still available without charge for academic, personal and non-commercial use. By using it, you automatically accept our Terms and Conditions.

Commercial QLattices

Using Feyn and the QLattice for commercial purposes will require a license key. Please contact us for details on this.

← InstallationWhat is a QLattice? →
  • Changes
  • Community QLattices
  • Commercial QLattices
Copyright © 2022 Abzu.ai
Feyn®, QGraph®, and the QLattice® are registered trademarks of Abzu®