Skip to main content

Getting Started

This document covers how to install the studio app and key concepts to make the most out of it. In order to create a project, you will need to create an account, and the login flow will guide you through the process

Setup​

Download the Smartloop Studio and open the app. This will start the initial setup process. This will take a few minutes based on your configuration. Once everything is set up and ready, you will be presented with a "General Chat", which is the default view where you can try basic prompts and extraction from your query.

First look

Best Performance

For best performance, use either an Apple Silicon Mac (M1 or newer) or an NVIDIA GPU with at least 4 GB of VRAM and CUDA 12.4.

Larger GPUs allow orchestration to select larger models for better task quality and performance, instead of defaulting to smaller models such as a 1B parameter model.

Creating Project​

A project is where you consolidate your documents and skills. This is your personal space to collect data, extract information, and prepare a model that works best for you. It grows with you — tailor it to suit your needs.

You can create a blank project or import an existing template to work that is shared with you

First look

Adding Documents​

You can add documents of the following format:

  • PDF
  • DOC
  • TXT

OCR documents require vision capabilities. Follow the orchestration documentation to understand how model selection works.

Below is an annotation of various key functionality of the app

annotated

Attachments​

Attachments are context documents — such as invoices or receipts — that you would quickly want to summarize and bring into the conversation.

Attachment size is limited to 4096 tokens, which is roughly 10 pages.

Sharing a Project​

You can share a project and all its content. To do so, open the project settings by clicking the settings icon, then click the Share button. This will package the project — including its documents and skills — into a zip file that you can send to others. The recipient can then import it as a new project template.

Project Settings

Monitoring​

Monitoring Logs

Once the app is installed, logs can be found at ~/.smartloop/server.log. On macOS or Linux-based systems, you can view the logs with:

less ~/.smartloop/server.log

These logs provide information about whether the agent selected the expected model and whether it could not process a user prompt due to GPU limitations.

Once you are logged in, each prompt you send uses tokens. The token count is reported to the console, which is used to render the dashboard that includes the tokens consumed over the last seven days and cost saved.

dashboard

We use the following API to report token usage: https://api.smartloop.ai/redoc#tag/usage

None of your content or data is sent, since we use this product ourselves and we deeply value your privacy.