Merge pull request #98 from Kiln-AI/scosman-docs-update

Update repo docs to point to docs.getkiln.ai
Kiln-AI · Jan 6, 2025 · 874efbc · 874efbc
2 parents 0ee2467 + 912a178
commit 874efbc
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -4,17 +4,24 @@
     </picture>
 </p>
 <h3 align="center">
-    The easiest tool for fine-tuning LLM models, synthetic data generation, and collaborating on datasets.
+    Rapid AI Prototyping and Dataset Collaboration Tool
 </h3>
 
+<p align="center">
+  <a href="https://docs.getkiln.ai/docs/fine-tuning-guide"><strong>Fine Tuning</strong></a> •
+  <a href="https://docs.getkiln.ai/docs/synthetic-data-generation"><strong>Synthetic Data Generation</strong></a> • 
+  <a href="https://docs.getkiln.ai/docs/collaboration"><strong>Dataset Collaboration</strong></a> • 
+  <a href="https://docs.getkiln.ai"><strong>Docs</strong></a>
+</p>
+
 |         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | CI      | [![Build and Test](https://github.com/Kiln-AI/kiln/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/Kiln-AI/kiln/actions/workflows/build_and_test.yml) [![Format and Lint](https://github.com/Kiln-AI/kiln/actions/workflows/format_and_lint.yml/badge.svg)](https://github.com/Kiln-AI/kiln/actions/workflows/format_and_lint.yml) [![Desktop Apps Build](https://github.com/Kiln-AI/kiln/actions/workflows/build_desktop.yml/badge.svg)](https://github.com/Kiln-AI/kiln/actions/workflows/build_desktop.yml) [![Web UI Build](https://github.com/Kiln-AI/kiln/actions/workflows/web_format_lint_build.yml/badge.svg)](https://github.com/Kiln-AI/kiln/actions/workflows/web_format_lint_build.yml) [![Test Count Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/scosman/57742c1b1b60d597a6aba5d5148d728e/raw/test_count_kiln.json)](https://github.com/Kiln-AI/kiln/actions/workflows/test_count.yml) [![Test Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/scosman/57742c1b1b60d597a6aba5d5148d728e/raw/library_coverage_kiln.json)](https://github.com/Kiln-AI/kiln/actions/workflows/test_count.yml) [![Docs](https://github.com/Kiln-AI/Kiln/actions/workflows/build_docs.yml/badge.svg)](https://github.com/Kiln-AI/Kiln/actions/workflows/build_docs.yml) |
 | Package | [![PyPI - Version](https://img.shields.io/pypi/v/kiln-ai.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/kiln-ai/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/kiln-ai.svg?logo=python&label=Python&logoColor=gold)](https://pypi.org/project/kiln-ai/)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | Meta    | [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![types - Pyright](https://img.shields.io/badge/types-pyright-blue.svg)](https://github.com/microsoft/pyright) [![Docs](https://img.shields.io/badge/docs-pdoc-blue)](https://kiln-ai.github.io/Kiln/kiln_core_docs/index.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
 | Apps    | [![MacOS](https://img.shields.io/badge/MacOS-black?logo=apple)](https://github.com/Kiln-AI/Kiln/releases/latest) [![Windows](https://img.shields.io/badge/Windows-0067b8.svg?logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPHN2ZyBmaWxsPSIjZmZmIiB2aWV3Qm94PSIwIDAgMzIgMzIiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTE2Ljc0MiAxNi43NDJ2MTQuMjUzaDE0LjI1M3YtMTQuMjUzek0xLjAwNCAxNi43NDJ2MTQuMjUzaDE0LjI1NnYtMTQuMjUzek0xNi43NDIgMS4wMDR2MTQuMjU2aDE0LjI1M3YtMTQuMjU2ek0xLjAwNCAxLjAwNHYxNC4yNTZoMTQuMjU2di0xNC4yNTZ6Ij48L3BhdGg+Cjwvc3ZnPg==)](https://github.com/Kiln-AI/Kiln/releases/latest) [![Linux](https://img.shields.io/badge/Linux-444444?logo=linux&logoColor=ffffff)](https://github.com/Kiln-AI/Kiln/releases/latest)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
-[<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)
+[<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) [<img width="220" alt="Quick start button" src="https://github.com/user-attachments/assets/aff1b35f-72c0-4286-9b28-40a415558359">](https://docs.getkiln.ai/getting-started/quickstart)
 
 ## Key Features
 
@@ -55,11 +62,13 @@ pip install kiln-ai
 
 ## Guides
 
-- [Fine Tuning LLM Models](guides/Fine%20Tuning%20LLM%20Models%20Guide.md)
-- [Synthetic Data Generation](guides/Synthetic%20Data%20Generation.md)
-- [Collaborating with Kiln](guides/Collaborating%20with%20Kiln.md) - How to share Kiln projects with your team.
+- [Fine Tuning LLM Models](https://docs.getkiln.ai/docs/fine-tuning-guide)
+- [Synthetic Data Generation](https://docs.getkiln.ai/docs/synthetic-data-generation)
+- [Collaborating with Kiln](https://docs.getkiln.ai/docs/collaboration) - How to share Kiln projects with your team.
+- [How to use any AI model or provider in Kiln](https://docs.getkiln.ai/docs/models-and-ai-providers)
+- [Organizing Kiln Datasets](https://docs.getkiln.ai/docs/organizing-datasets)
+- [Rating and Labeling Data](https://docs.getkiln.ai/docs/reviewing-and-rating)
 - [Using the Kiln Python Library](https://kiln-ai.github.io/Kiln/kiln_core_docs/kiln_ai.html) - Includes how to load datasets into Kiln, or using Kiln datasets in your own projects/notebooks.
-- [Model Support](guides/Model%20Support.md) - Included models, and how to add more.
 
 ## Learn More
 

diff --git a/guides/Collaborating with Kiln.md b/guides/Collaborating with Kiln.md
@@ -1,5 +1,15 @@
 # Guide: Collaborating with Kiln
 
+---
+
+# This guide as moved to [our docs](https://docs.getkiln.ai/docs/collaboration). This page may be out of date.
+
+We suggest reading the [latest version](https://docs.getkiln.ai/docs/collaboration).
+
+---
+
+## Original Content
+
 Kiln is designed to be a collaborative environment for building AI projects. This guide will help you understand how a team can collaborate with Kiln.
 
 ## Table of Contents

diff --git a/guides/Fine Tuning LLM Models Guide.md b/guides/Fine Tuning LLM Models Guide.md
@@ -1,5 +1,19 @@
 # Guide: Fine Tuning 9 Models in 18 minutes with [Kiln AI](https://getkiln.ai)
 
+
+---
+
+# This guide as moved to [our docs](https://docs.getkiln.ai/docs/fine-tuning-guide). This page may be out of date.
+
+We suggest reading the [latest version](https://docs.getkiln.ai/docs/fine-tuning-guide).
+
+---
+
+
+
+
+## Original content
+
 [Kiln](https://getkiln.ai) is a new tool that makes it easy to fine-tune a wide variety of models like GPT-4o, Llama, Mistral, Gemma, and many more.
 
 ## Overview

diff --git a/guides/Model Support.md b/guides/Model Support.md
@@ -1,5 +1,16 @@
 # Model Support
 
+
+---
+
+# This guide as moved to [our docs](https://docs.getkiln.ai/docs/models-and-ai-providers). This page may be out of date.
+
+We suggest reading the [latest version](https://docs.getkiln.ai/docs/models-and-ai-providers).
+
+---
+
+## Original Content
+
 Kiln can use essentially any LLM model.
 
 Models come in a range of flavours, from very easy to use, to advanced methods for expert users

diff --git a/guides/Synthetic Data Generation.md b/guides/Synthetic Data Generation.md
@@ -1,5 +1,17 @@
 # Synthetic Data Generation - Kiln AI 
 
+
+---
+
+# This guide as moved to [our docs](https://docs.getkiln.ai/docs/synthetic-data-generation). This page may be out of date.
+
+We suggest reading the [latest version](https://docs.getkiln.ai/docs/synthetic-data-generation).
+
+---
+
+## Original Content
+
+
 [Kiln](https://getkiln.ai) can generate synthetic data for your tasks.