nillion-aivm 0.1.1

AIVM: secure infrastructure for running MLaaS.

Nillion AIVM

AIVM is a framework designed for private inference using cryptographic protocols. This project allows you to run a development network (devnet) and perform private inference tasks using examples provided in the repository.

Table of Contents

• Installing AIVM
  • Recommended Installation
  • Using Poetry
  • Using venv
• Running AIVM
• Usage
• Contributing
• License

Installing AIVM

Recommended Instalation

1. Install on your existing OS python installation. Requires Python >=3.12:

   git clone https://github.com/NillionNetwork/aivm.git
   cd aivm
   

2. Install dependencies:

   pip install .
   

If you are going to run the examples, do:

pip install ".[examples]"

Using Poetry

1. Install Poetry (if not already installed):

   pip install poetry
   

2. Clone the repository:

   git clone https://github.com/NillionNetwork/aivm.git
   cd aivm
   

3. Install dependencies:

   poetry install
   

4. Activate the virtual environment:

   poetry shell
   

5. Install AIVM:

   poetry install
   

Using venv

1. Clone the repository:

   git clone https://github.com/NillionNetwork/aivm.git
   cd aivm
   

2. Create a virtual environment:

   python3 -m venv .venv
   

3. Activate the virtual environment:

   On Linux/macOS:

   source .venv/bin/activate
   

   On Windows:

   .\venv\Scripts\activate
   

4. Install the package:

   pip install .
   

Running AIVM

1. Start the AIVM devnet:

   aivm-devnet
   

2. Open the provided Jupyter notebook examples/getting-started.ipynb to run private inference examples on AIVM.

3. After completing your tasks, terminate the devnet process by pressing CTRL+C.

Usage

For additional usage, refer to the examples provided in the examples folder, which demonstrates how to set up private inference workflows using AIVM.