wehub-resource-sync
97e91a83f3
Ruff / Ruff (push) Has been cancelled
Test / Core Tests (push) Has been cancelled
Test / Offline Coverage Tests (Python 3.10) (push) Has been cancelled
Test / Offline Coverage Tests (Python 3.11) (push) Has been cancelled
Test / Offline Coverage Tests (Python 3.12) (push) Has been cancelled
Test / Offline Coverage Tests (Python 3.13) (push) Has been cancelled
Test / Offline Coverage Tests (Python 3.9) (push) Has been cancelled
Test / Full Coverage (Python 3.11) (push) Has been cancelled
Test / Core Provider Tests (OpenAI) (push) Has been cancelled
Test / Core Provider Tests (Anthropic) (push) Has been cancelled
Test / Core Provider Tests (Google) (push) Has been cancelled
Test / Core Provider Tests (Other) (push) Has been cancelled
Test / Anthropic Tests (push) Has been cancelled
Test / Gemini Tests (push) Has been cancelled
Test / Google GenAI Tests (push) Has been cancelled
Test / Vertex AI Tests (push) Has been cancelled
Test / OpenAI Tests (push) Has been cancelled
Test / Writer Tests (push) Has been cancelled
Test / Auto Client Tests (push) Has been cancelled
ty / type-check (push) Has been cancelled
27 lines
721 B
Markdown
27 lines
721 B
Markdown
---
|
|
title: Repository Overview
|
|
description: 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.
|
|
|