Skip to content

Commit

Permalink
docs: what is this?
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelovicentegc committed Dec 17, 2023
1 parent c7a1644 commit 5052756
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@

---

## Human-in-the-loop sequence
## What is this?

Chiron is a simple back-office service that allows you to create a human-in-the-loop system for your AI models. It's a simple service that offers a visual interface to review data generated by your AI model. It's simple API allows you to send generated data from your AI model to Chiron, and receive the reviewed data back to the specified callback URL.

### Operation

```mermaid
sequenceDiagram
Expand Down Expand Up @@ -49,8 +53,8 @@ Before deploying this service, make sure you have access to a:
- SMTP server
- MongoDB instance

Take a look at the `.env.example` file to see which environment variables you need to set up.
Take a look at the `.env.example` file to see which environment variables you need to set up the application.

This project is deployed using [Vercel](https://vercel.com/). You can deploy your own instance using the button below (feel free to deploy it anywhere else):

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/eutiveumsonho/chiron)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/eutiveumsonho/chiron)
1 change: 0 additions & 1 deletion containers/api-management.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/** @module containers/api-management */

"use client";

import Empty from "@/components/empty";
Expand Down

0 comments on commit 5052756

Please sign in to comment.