NDIF Development Guide

This guide explains how to set up a development environment, install dependencies, and get started with contributing to the NDIF project.

Prerequisites

• Python 3.10
• Docker
• Docker Compose

Setup

3. Install NNsight

Choose one of the following methods:

a. Via pip (simple)

pip install nnsight

b. From repository (recommended for specific branches)

git clone https://github.com/nnsight/nnsight.git
cd nnsight
git checkout <branch-name>  # e.g., 0.3
pip install -e .

Building and Running NDIF

1. Build the base environment

First, build the base environment using the make build_all_base command. This will set up the base images.

make build_all_base

2. Build the service

Next, build the service using the make build_all_service command.

make build_all_service

3. Start the development containers

After building the base environment and the service, start the NDIF docker containers.

make up-dev

4. Verify server status

After building the NDIF containers, you can check the docker logs to verify the services are running correctly.

docker logs dev-api-1

You should expect to see a message like Application startup complete. in the api service log.

5. Run tests

python scripts/test.py

This will send 3 NNsight requests to the API service running in the local container.