Brev Console Reference

The Brev Console is a web-based interface for creating, managing, and accessing your instances. It's a great way to get started with Brev and get started with your first AI project.

Quick Start

To get started, you'll need to create an account on Brev. You can do this by clicking the "Create an account" button in the top right corner of the console.

Once you've created an account, you can start creating your first instance by clicking the "Create a new instance" button in the top right corner of the console.

The Brev Console is divided into several sections, including:

Instances: This section allows you to create and manage your instances.
Discover: This section allows you to discover and deploy our premade Launchables for various AI use cases including Image Generation, Text Generation, and more.
People: This section allows you to manage team members in your organization and invite new members.
Billing: This section allows you to view and manage your billing information.
Docs: This section brings you right back here :)

Instances

The Instances section allows you to create, start, stop, and delete your instances. You can also view your instance's status and logs.

Create a new instance

To create a new instance, click the "+ New" button in the top right corner of the console. This will bring up our Instance Creation page where you can select your hardware (GPU or CPU), select a base image (optional), configure storage, and deploy the instance.

Instance Deployment

Once you've deployed your instance, you'll be take to the Instance Details page. Here, you can view your instance's status, logs, and access your Jupyter Notebook. On this page, view your instance's status and logs and access any a Jupyter Lab connected to your machine. The Access section shows you how to access your instance from your local machine.

Exposing ports

In the Access section of the Instance Details page, you can expose ports to your instance. This is helpful if you want to expose an API to your model for inference or simply want to access your instance from a different machine. We use Cloudflare tunnels to expose ports. If you expose and port but cannot access it, reach out to us!

Notebooks

The Notebooks section allows you to deploy our premade notebooks for various AI use cases. We have notebooks for most open-source models including Llama3, Mixtral 8x7b, Stable Difusion, and more.

Deploy a Notebook

To deploy a notebook, click the "Deploy Now 🚀" button in the top right corner of the console. This will bring up a stepper where you can interactively view the hardware, deployment logs, and eventually access your notebook. This notebook can also be viewed through the Instance Details page.

People

The People section allows you to manage team members in your organization and invite new members.

Invite a new member

There are 2 ways to invite a new member to your organization:

Generate an invite link
Invite by username. Here you can choose read only or read and write access.

Billing

The Billing section allows you to view and manage your billing information. Billing is organized by organization. Here you can add a credit card to your account and view your billing history. We charge using credits and you can refill your account balance at any time.