Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
scosman committed Jan 10, 2025
1 parent fce9471 commit 96e9151
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,19 @@
- 🎛️ **Fine Tuning**: Zero-code fine-tuning for Llama, GPT4o, and Mixtral. Automatic serverless deployment of models.
- 🤖 **Synthetic Data Generation**: Generate training data with our interactive visual tooling.
- 🤝 **Team Collaboration**: Git-based version control for your AI datasets. Intuitive UI makes it easy to collaborate with QA, PM, and subject matter experts on structured data (examples, prompts, ratings, feedback, issues, etc.).
- 📝 **Auto-Prompts**: Generate a variety of prompts from your data, including chain-of-thought, few-shot, and multi-shot.
- 📝 **Prompt Generation**: Automatically generate prompts from your data, including chain-of-thought, few-shot, and multi-shot, and more.
- 🌐 **Wide Model and Provider Support**: Use any model via Ollama, OpenAI, OpenRouter, Fireworks, Groq, AWS, or any OpenAI compatible API.
- 🧑‍💻 **Open-Source Library and API**: Our Python library and OpenAPI REST API are MIT open source.
- 🔒 **Privacy-First**: We can't see your data. Bring your own API keys or run locally with Ollama.
- 🗃️ **Structured Data**: Build AI tasks that speak JSON.
- 💰 **Free**: Our apps are free, and our library is open-source.

## Download Kiln Desktop Apps

The Kiln desktop app is completely free. Available on MacOS, Windows and Linux.

[<img width="220" alt="Download button" src="https://github.com/user-attachments/assets/a5d51b8b-b30a-4a16-a902-ab6ef1d58dc0">](https://github.com/Kiln-AI/Kiln/releases/latest)

## Demo

In this demo, I create 9 fine-tuned models (including Llama 3.x, Mixtral, and GPT-4o-mini) in just 18 minutes, achieving great results for less than $6 total cost. [See details](guides/Fine%20Tuning%20LLM%20Models%20Guide.md).
Expand All @@ -44,12 +50,6 @@ In this demo, I create 9 fine-tuned models (including Llama 3.x, Mixtral, and GP
<img alt="Kiln Preview" src="https://github.com/user-attachments/assets/51db632b-be98-4fc6-a31c-0ba6fd54dcbb">
</a>

## Download Kiln Desktop Apps

The Kiln desktop app is completely free. Available on MacOS, Windows and Linux.

[<img width="220" alt="Download button" src="https://github.com/user-attachments/assets/a5d51b8b-b30a-4a16-a902-ab6ef1d58dc0">](https://github.com/Kiln-AI/Kiln/releases/latest)

## Docs & Guides

Kiln is quite intuitive, so we suggest launching the desktop app and diving in. However if you have any questions or want to learn more, our [docs are here to help](https://docs.getkiln.ai).
Expand Down
11 changes: 7 additions & 4 deletions libs/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The library has a [comprehensive set of docs](https://kiln-ai.github.io/Kiln/kil
- [Load an Existing Dataset into a Kiln Task Dataset](#load-an-existing-dataset-into-a-kiln-task-dataset)
- [Using your Kiln Dataset in a Notebook or Project](#using-your-kiln-dataset-in-a-notebook-or-project)
- [Using Kiln Dataset in Pandas](#using-kiln-dataset-in-pandas)
- [Advanced Usage](#advanced-usage)
- [Full API Reference](#full-api-reference)

## Installation

Expand All @@ -62,11 +62,14 @@ The Kiln Python library provides a set of Python classes that which help you eas

### Datamodel Overview

Here's a high level overview of the Kiln datamodel. A project folder will reflect this nested structure:

- Project: a Kiln Project that organizes related tasks
- Task: a specific task including prompt instructions, input/output schemas, and requirements
- TaskRun: a sample (run) of a task including input, output and human rating information
- DatasetSplit: a frozen collection of task runs divided into train/test/validation splits
- Finetune: configuration and status tracking for fine-tuning models on task data
- Prompt: a prompt for this task
- DatasetSplit: a frozen collection of task runs divided into train/test/validation splits

### Load a Project

Expand Down Expand Up @@ -197,8 +200,8 @@ final_df = pd.concat(dfs, ignore_index=True)
print(final_df)
```

### Advanced Usage
## Full API Reference

The library can do a lot more than the examples we've shown here.

See the [docs](https://kiln-ai.github.io/Kiln/kiln_core_docs/index.html) for more information.
See the full API reference in the [docs](https://kiln-ai.github.io/Kiln/kiln_core_docs/index.html) under the `Submodules` section of the sidebar.
1 change: 1 addition & 0 deletions libs/core/kiln_ai/datamodel/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"TaskRequirement",
"strict_mode",
"set_strict_mode",
"Prompt",
]


Expand Down

0 comments on commit 96e9151

Please sign in to comment.