Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/usage/retrieval_core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Usage Example: retrieval_core

`retrieval_core` is a probabilistic task used for document indexing and query estimation.

## Example Script

```python
Comment thread
Aaryan-Dadu marked this conversation as resolved.
from chuck.tasks.retrieval_core.task import solve, generate

Comment thread
Aaryan-Dadu marked this conversation as resolved.
# 1. Generate sample data (documents and queries)
payload = generate(count=100, seed=42)

# 2. Execute the retrieval solver
# The payload contains 'docs' and 'queries'
results = solve(payload)

# 3. View Probabilistic Results
print(f"Confidence: {results['confidence']}")
print(f"Query Hits: {results['query_hits']}")
print(f"Top Term: {results['top_term']}")
```

# Outputs
```text
Confidence: 0.875
Query Hits: {'eta': 68, 'kappa': 76, 'alpha': 72, 'delta': 70}
Top Term: epsilon
```
Loading