Skip to main content

Installation

You will need Python 3.8+ to install Xircuits.

tip

We recommend installing in a virtual environment such as Python venv.

$ python -m venv venv
$ source venv/Scripts/activate

To install Xircuits run:

$ pip install xircuits

Installing Xircuits Component Libraries

Before being able to use a component library, you need to install them via pip install xircuits[packageName].

For example, to be able to use the Pytorch components, run:

$ pip install xircuits[pytorch]

Additionally you can also get all the component library packages via:

$ pip install xircuits[full]

We wouldn't recommended it though as it's very large! For the full list of supported libraries, you can visit the component libraries page.

Download Examples

We have provided some workflows for you to try. To fetch them, run:

$ xircuits-examples

Launch

Finally to launch it, run:

$ xircuits

You will be prompted to load the xai_components in the current path. We recommend doing so to be able to edit them.