Skip to content

Commit d777b3f

Browse files
authored
Merge pull request #5 from Open-Paws/chore/agent-context-cleanup
chore: add CLAUDE.md agent context
2 parents 9e1cdec + cf2a2f9 commit d777b3f

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

CLAUDE.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Documentation
2+
3+
Developer documentation for the Open Paws AI ecosystem: vector database, prediction models, generative language models, workflow automations, and HuggingFace datasets. This is the central reference for anyone building AI tools for animal advocacy using Open Paws infrastructure.
4+
5+
## Quick Start
6+
7+
No build step -- this is a pure documentation repo. Browse by topic:
8+
9+
- **Vector database (Weaviate):** `Knowledge/README.md`
10+
- **Prediction models:** `Predictions/README.md`
11+
- **Language models (8B):** `Generation/README.md`
12+
- **n8n workflow automations:** `Automation/README.md`
13+
14+
## Architecture
15+
16+
```
17+
Knowledge/ Weaviate vector-graph database docs (connection, search, RAG, schema)
18+
Predictions/ HuggingFace text regression models (performance + preference prediction)
19+
Generation/ 8B language models (Llama 3.1 base, continual pre-training + instruct)
20+
Automation/ n8n workflow templates for advocacy automation
21+
.github/ Dependabot config + CI workflows
22+
```
23+
24+
## Key Files
25+
26+
| File | Purpose |
27+
|------|---------|
28+
| `Knowledge/README.md` | Weaviate connection details, search ops, RAG patterns, Content schema |
29+
| `Predictions/README.md` | Prediction model usage, batch processing, score clipping |
30+
| `Generation/README.md` | 8B model usage, generation parameters, known limitations |
31+
| `Automation/README.md` | n8n hosting options, workflow import, activation |
32+
| `.gitleaksignore` | Secret scanning exclusions (read-only API keys in docs) |
33+
34+
## External Dependencies
35+
36+
| Service | Purpose | Docs |
37+
|---------|---------|------|
38+
| Weaviate Cloud | Vector-graph database (read-only access) | [weaviate.io](https://weaviate.io/developers/weaviate) |
39+
| HuggingFace | Model hosting + datasets | [huggingface.co/open-paws](https://huggingface.co/open-paws) |
40+
| OpenAI API | Embeddings for Weaviate search | [platform.openai.com](https://platform.openai.com/docs) |
41+
| OpenRouter | LLM routing (used by downstream tools) | [openrouter.ai](https://openrouter.ai) |
42+
| n8n | Workflow automation platform | [docs.n8n.io](https://docs.n8n.io) |
43+
44+
## HuggingFace Datasets
45+
46+
- [Conversational Fine-Tuning](https://huggingface.co/datasets/open-paws/conversational-finetuning)
47+
- [Continued Pre-Training](https://huggingface.co/datasets/open-paws/continued-pretraining)
48+
- [Visual Q&A](https://huggingface.co/datasets/open-paws/visual-qa)
49+
- [Animal Alignment Feedback](https://huggingface.co/datasets/open-paws/animal-alignment-feedback)
50+
- [Reasoning](https://huggingface.co/datasets/open-paws/reasoning)
51+
- [Tool Use](https://huggingface.co/datasets/open-paws/tool-use)
52+
53+
## Development
54+
55+
- **Adding documentation:** Create a new directory with a `README.md` following the existing pattern
56+
- **Code examples:** Python with `transformers` or `weaviate` client libraries -- keep examples copy-pasteable
57+
- **Style:** Each section should be self-contained with connection details, code samples, and best practices

0 commit comments

Comments
 (0)