Installation
You will need Python 3.8+ to install Xircuits.
We recommend installing in a virtual environment such as Python venv.
- Windows
- MacOS / Linux
python -m venv venv
source venv/Scripts/activate
python -m venv venv
source venv/bin/activate
To install Xircuits, run:
pip install xircuits
Canary Installation
If you're interested in the cutting-edge features of Xircuits (which might include unstable features), you can get the latest version directly from our Github Actions. Look for a Python Package Builder run on the master branch, and download the wheel artifact.
Video
After downloading, extract the wheel to your working directory and install it with:
pip install xircuits-version-py3.none-any.whl
Installing Xircuits Component Libraries
Xircuits is designed to be extensible, featuring a variety of component libraries to enhance its functionality. While it comes with a set of pre-installed components, you might find yourself in need of more specialized functionalities that are offered by external component libraries.
Installing these libraries is straightforward. For example, to use the Pytorch components from our Pytorch component library, simply run:
xircuits install pytorch
To explore and install other component libraries, check out the full list on the component libraries page. The components listed here may also be installed via component library interface.
Launch
To start using Xircuits, execute:
xircuits
Upon launch, xai_components
will be loaded in your current working directory.