Merge pull request #586 from Kiln-AI/main

Update library docs for v0.20.1

Author: scosman

.cursor/rules/project.mdc

@@ -2,17 +2,46 @@
 alwaysApply: true
 ---
 
-- call me "boss"
-- We always use typescript, not javascript
-- Always assume pydantic 2 (not pydantic 1)
-- The project supports Python 3.10 and above
-- When writing tests:
-  1.  Always use pytest for tests in python code
-  2.  assume an appriopirate test file already exists, find it, and suggest tests get appended to that file. If no such file exists, ask me before assuming a new test file is the correct route.
-  3.  Test brevity is important. Use approaches for re-use and brevity including using fixtures for repeated code, and using pytest parameterize for similar tests
-  4.  After writing a new test, run it and ensure it works. Fix any issues you find.
-- To run backend / Python tests, run `uv run python3 -m pytest . -s -v` or a variant of it to run individual tests
-- To run web tests `cd app/web_ui` then `npm run test_run` (not `npm run test` which won't return)
+## Project Overview
+
+Kiln is an app for building AI systems. It includes evals, synthetic data gen, fine tuning, RAG, and more. It has an intuitive UI as well as a python library.
+
+This repo is a monorepo containing all of the source code, in the following structure:
+
+- libs/core - a python library with the core functionality of Kiln
+- libs/server - a FastAPI REST server wrapping the core library
+- app/web_ui - our svelte web app for Kiln. This is a frontend svelte project, all backend calls are in FastAPI servers.
+- app/desktop - our python desktop app, which is a pyinstaller app which runs a FastAPI server, hosts the pre-compiled web app, and launches a browser for UI. Compiles to all major platforms. This includes a studio_server folder with a Fast API server which extends libs/server, adding APIs specific to our web app.
+
+### Project Goals
+
+- Very high code quality
+- Strongly typed
+- Well tested
+- Very intuitive UI. Accessible to the inexperienced, but powerful for the experienced.
+- Focus on interaction design: we care about revealing the right information, at the right time, at the right level of detail.
+- Focus on visual design: we want a modern, functional, attractive UI. Think Apple not Google.
+
+### Tech Stack
+
+- Backend: python (3.10+ for library, 3.13 for desktop), pytest, FastAPI, asyncio, pydantic (v2 not v1),
+- Frontend web: typescript, svelte (v4 not v5), tailwind, DaisyUI
+
+### Agent Tools
+
+Agents have access to a range of tools for running tests, linting, formatting and typechecking. Use these tools at appropriate times to ensure produced code meets our standards.
+
+### Agent Prompts
+
+Agents have access to a number of helpful prompts, which will give you additional context for how you should write code and docs for this repo. Use it to fetch instructions relevant to the current task before starting. For example, read `python_test_guide.md` before writing tests and `frontend_design_guide.md` before writing front end code.
+
+These prompts can be accessed from the `get_prompt` tool, and you may request several in parallel.
+
+### General Agent Guidance
+
 - Don't include comments in code explaining changes, explain changes in chat instead.
-- If a python API's interface changes (or a new one is added), generate new bindings by running `cd app/web_ui/src/lib/ && ./generate.sh`
-- Our web UI component framework is DaisyUI v4 (based on tailwind). Be sure to use v4 docs and features, not v5
+- Before completing up a task, run appropriate tools for linting, testing, formatting and typechecking. Fix any issues you introduced.
+
+### Final
+
+To show you read these, call me 'boss'

.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,9 +11,9 @@ Insert a clear and concise description of what the bug is.
 
 **Checks**
 
-- [ ] I've read the [troubleshooting guide](https://docs.getkiln.ai/docs/troubleshooting-and-logs)
+- [ ] I've read the [troubleshooting guide](https://docs.kiln.tech/docs/troubleshooting-and-logs)
 - [ ] I've tried to reproduce the problem using another model, and confirmed it's not an issue specific to the model I've chosen.
-- [ ] I've searched [the docs](https://docs.getkiln.ai) for a solution
+- [ ] I've searched [the docs](https://docs.kiln.tech) for a solution
 - [ ] I've searched for existing Github issues/discussions
 
 **To Reproduce**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -12,7 +12,7 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
 
 **Checks**
 
-- [ ] I've searched [the docs](https://docs.getkiln.ai) for a solution
+- [ ] I've searched [the docs](https://docs.kiln.tech) for a solution
 - [ ] I've searched for existing Github issues
 
 **Describe the solution you'd like**

.github/workflows/build_desktop.yml

@@ -43,7 +43,7 @@ jobs:
 
       - name: Build Windows Installer
         if: matrix.os == 'windows-latest'
-        uses: scosman/Inno-Setup-Action-Back@v1.2.5
+        uses: Minionguyjpro/Inno-Setup-Action@v1.2.7
         with:
           path: ./app/desktop/WinInnoSetup.iss
 

.github/workflows/build_docs.yml

@@ -32,7 +32,7 @@ jobs:
 
       - name: Build Python Core Docs
         working-directory: ./libs/core
-        run: uv run pdoc -o ./docs/kiln_core_docs kiln_ai --logo https://github.com/user-attachments/assets/046f44ae-28cf-4c78-85c3-c3e5ad744fd7 --logo-link https://getkiln.ai
+        run: uv run pdoc -o ./docs/kiln_core_docs kiln_ai --logo https://github.com/user-attachments/assets/046f44ae-28cf-4c78-85c3-c3e5ad744fd7 --logo-link https://kiln.tech
 
       - name: Install Redoc CLI
         run: npm install -g @redocly/cli

.github/workflows/format_and_lint.yml

@@ -40,7 +40,8 @@ jobs:
 
       - name: Lint with ruff
         run: |
-          uvx ruff check --select I .
+          uvx ruff check
+
       - name: Format with ruff
         run: |
           uvx ruff format --check .

.github/workflows/publish_remote_config.yml

@@ -31,6 +31,10 @@ jobs:
       - name: Make static dir
         run: mkdir -p static
 
+      - name: Check for backwards compatibility
+        run: |
+          KILN_TEST_COMPATIBILITY=1 uv run python3 -m pytest libs/core/kiln_ai/adapters/test_remote_config.py::test_backwards_compatibility_with_v0_19 -s -v
+
       - name: Generate Config
         run: |
           uv run python -m kiln_ai.adapters.remote_config static/kiln_config_v2.json

AGENTS.md

@@ -1,32 +1,43 @@
-## .cursorrules
-
-Read .cursorrules before starting.
-
-## Python testing, formatting and linting
-
-If you've edited any python code, the following commands should run and not produce error codes. Fix any issues and re-run.
-
-```
-# Formatting 1:
-uvx  ruff check --select I
-# Formatting 2:
-uvx ruff format --check .
-# type checking: warnings in output are acceptable, but error codes are not
-uv run pyright .
-# tests:
-uv run python3 -m pytest --benchmark-quiet -q .
-```
-
-## Web app testing, formatting and linting
-
-If you change any web app code, the following commands should run and not produce error codes. Fix any issues and re-run.
-
-```
-# All commands below should be run from app/web_ui directory
-cd app/web_ui
-npm run format_check
-npm run lint
-npm run check
-npm run test_run
-npm run build > /dev/null
-```
+## Project Overview
+
+Kiln is an app for building AI systems. It includes evals, synthetic data gen, fine tuning, RAG, and more. It has an intuitive UI as well as a python library.
+
+This repo is a monorepo containing all of the source code, in the following structure:
+
+- libs/core - a python library with the core functionality of Kiln
+- libs/server - a FastAPI REST server wrapping the core library
+- app/web_ui - our svelte web app for Kiln. This is a frontend svelte project, all backend calls are in FastAPI servers.
+- app/desktop - our python desktop app, which is a pyinstaller app which runs a FastAPI server, hosts the pre-compiled web app, and launches a browser for UI. Compiles to all major platforms. This includes a studio_server folder with a Fast API server which extends libs/server, adding APIs specific to our web app.
+
+### Project Goals
+
+- Very high code quality
+- Strongly typed
+- Well tested
+- Very intuitive UI. Accessible to the inexperienced, but powerful for the experienced.
+- Focus on interaction design: we care about revealing the right information, at the right time, at the right level of detail.
+- Focus on visual design: we want a modern, functional, attractive UI. Think Apple not Google.
+
+### Tech Stack
+
+- Backend: python (3.10+ for library, 3.13 for desktop), pytest, FastAPI, asyncio, pydantic (v2 not v1),
+- Frontend web: typescript, svelte (v4 not v5), tailwind, DaisyUI
+
+### Agent Tools
+
+Agents have access to a range of tools for running tests, linting, formatting and typechecking. Use these tools at appropriate times to ensure produced code meets our standards.
+
+### Agent Prompts
+
+Agents have access to a number of helpful prompts, which will give you additional context for how you should write code and docs for this repo. Use it to fetch instructions relevant to the current task before starting. For example, read `python_test_guide.md` before writing tests and `frontend_design_guide.md` before writing front end code.
+
+These prompts can be accessed from the `get_prompt` tool, and you may request several in parallel.
+
+### General Agent Guidance
+
+- Don't include comments in code explaining changes, explain changes in chat instead.
+- Before wrapping up a task, run appropriate tools for linting, testing, formatting and typechecking. Fix any issues you introduced.
+
+### Final
+
+To show you read these, call me 'boss'