97e91a83f3
Ruff / Ruff (push) Waiting to run
Test / Core Tests (push) Waiting to run
Test / Offline Coverage Tests (Python 3.10) (push) Waiting to run
Test / Offline Coverage Tests (Python 3.11) (push) Waiting to run
Test / Offline Coverage Tests (Python 3.12) (push) Waiting to run
Test / Offline Coverage Tests (Python 3.13) (push) Waiting to run
Test / Offline Coverage Tests (Python 3.9) (push) Waiting to run
Test / Full Coverage (Python 3.11) (push) Waiting to run
Test / Core Provider Tests (OpenAI) (push) Blocked by required conditions
Test / Core Provider Tests (Anthropic) (push) Blocked by required conditions
Test / Core Provider Tests (Google) (push) Blocked by required conditions
Test / Core Provider Tests (Other) (push) Blocked by required conditions
Test / Anthropic Tests (push) Blocked by required conditions
Test / Gemini Tests (push) Blocked by required conditions
Test / Google GenAI Tests (push) Blocked by required conditions
Test / Vertex AI Tests (push) Blocked by required conditions
Test / OpenAI Tests (push) Blocked by required conditions
Test / Writer Tests (push) Blocked by required conditions
Test / Auto Client Tests (push) Blocked by required conditions
ty / type-check (push) Waiting to run
721 B
721 B
title, description
| title | description |
|---|---|
| Repository Overview | Learn the structure of the Instructor repository and the purpose of each major directory. |
Repository Overview
This page explains the layout of the Instructor codebase and what each key directory contains.
Directory Summary
instructor/
Core library with clients, adapters, and utilities for structured outputs.
cli/
Command-line interface code used for tasks like job management and usage tracking.
docs/
Documentation source files for the website built with MkDocs.
examples/
Practical examples and cookbooks demonstrating how to use Instructor.
tests/
Test suite and evaluation scripts ensuring the library functions correctly.