Skip to content

Commit

Permalink
added interfaces basics page.
Browse files Browse the repository at this point in the history
  • Loading branch information
djl11 committed Feb 19, 2025
1 parent 8890ce2 commit 80a1d0c
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 8 deletions.
56 changes: 56 additions & 0 deletions interfaces/basics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: 'Basics'
---

When you open a new project, you'll see an interface with **one tab** and **two tiles**.

IMG

## Tabs

Tabs are shown at the top centre of the screen, and an interface can have as many tabs as you want.

Tabs are useful for separating different concepts and data views within a project, for example: `Datasets`, `Usage`, `Evals`, `Metrics`, `Tests`.

Each tab can be tailored for it's specific purpose, making it easy to juggle all aspects of your project 🤹🏼

## Tiles

Tabs consist of **tiles**, which is where the data, interaction, and visualization actually happens. There are four types:

- tables 🔢
- views 🔍
- plots 📊
- editor 🕹️ (coming soon)

When in edit mode (`Ctrl + E`), new tiles can be added by clicking on any blank space in the tab, or by pressing `Ctrl + T`.
The corners of the tab can then be dragged for resizing, and the tab can be dragged and repositioned.

GIF

If you're done positioning and sizing your tiles, it's best to exit edit mode.
This will declutter the workspace, minimize the icons on screen and make the best use of all the tile space.

## Focus Mode

If you want to look at one tile in particular, you can expand this into the focus mode view.

GIF

You can also compare *any* two tiles side-by-side in focus mode, which is easier than moving them next to one another.

## Edit / Interactive Modes

Edit mode enables tile manipulation (as explained above) and interactive mode enables engagement with the tiles,
such as applying filters, sorting and grouping on tables, changing the axes selection on plots, and editing logs via the view tile.
When interactive mode is turned off, the interface acts more like a static dashboard.

GIF

## Feedback

These are the only concepts you should need to know to get started.
If anything is unclear, or there is another feature you'd like to see,
then let us know [on discord](https://discord.com/invite/sXyFF8tDtm)! 👾

Feedback is always welcome 🙏
4 changes: 2 additions & 2 deletions interfaces/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Every LLM product has unique and changing requirements, as do the users. Your in

<img class="dark-light" width="100%" src="https://raw.githubusercontent.com/unifyai/unifyai.github.io/refs/heads/main/img/externally_linked/notion_for_llm_observability.gif"/>

We've tried to make Unify as (a) simple, (b) modular and (c) hackable as possible,
so you can quickly probe, analyze, and iterate on the data that's important for you, your product and your users ⚡
We've tried to make Unify as **(a) simple**, **(b) modular** and **(c) hackable** as possible,
so you can quickly probe, analyze, and iterate on the data that's important for **you**, your **product** and your **users**

Head over to the next page to dive in! ➡️
4 changes: 0 additions & 4 deletions interfaces/tabs.mdx

This file was deleted.

3 changes: 1 addition & 2 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,7 @@
"group": "Interfaces",
"pages": [
"interfaces/overview",
"interfaces/tabs",
"interfaces/tiles",
"interfaces/basics",
"interfaces/tables",
"interfaces/views",
"interfaces/plots"
Expand Down

0 comments on commit 80a1d0c

Please sign in to comment.