From ec16a13a5c0414bf7cfd40e59e1d34b5f29ec86f Mon Sep 17 00:00:00 2001 From: Sreyash308 Date: Sun, 12 Apr 2026 01:02:35 +0530 Subject: [PATCH 1/3] docs: add usage example for retrieval_core #20 --- docs/usage/retrieval_core.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/usage/retrieval_core.md diff --git a/docs/usage/retrieval_core.md b/docs/usage/retrieval_core.md new file mode 100644 index 0000000..b6c68cf --- /dev/null +++ b/docs/usage/retrieval_core.md @@ -0,0 +1,20 @@ +# Usage Example: retrieval_core + +`retrieval_core` is a probabilistic task used for document indexing and query estimation. + +## Example Script + +```python +from chuck.tasks.retrieval_core.task import solve, generate + +# 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']}") \ No newline at end of file From 36f6137fca685e3c86309c8a7d20069895beae19 Mon Sep 17 00:00:00 2001 From: Sreyash308 Date: Sun, 12 Apr 2026 03:42:19 +0530 Subject: [PATCH 2/3] docs: Output Added in retrieval_core.md #20 --- docs/usage/retrieval_core.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/usage/retrieval_core.md b/docs/usage/retrieval_core.md index b6c68cf..018cc6a 100644 --- a/docs/usage/retrieval_core.md +++ b/docs/usage/retrieval_core.md @@ -17,4 +17,12 @@ 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']}") \ No newline at end of file +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 +``` \ No newline at end of file From 260355c57907bd5cdaa84d29e48ef798631f099b Mon Sep 17 00:00:00 2001 From: Sreyash308 Date: Sun, 12 Apr 2026 12:47:07 +0530 Subject: [PATCH 3/3] fixing CI checks which are failing --- docs/usage/retrieval_core.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage/retrieval_core.md b/docs/usage/retrieval_core.md index 018cc6a..2a4f64f 100644 --- a/docs/usage/retrieval_core.md +++ b/docs/usage/retrieval_core.md @@ -25,4 +25,4 @@ print(f"Top Term: {results['top_term']}") Confidence: 0.875 Query Hits: {'eta': 68, 'kappa': 76, 'alpha': 72, 'delta': 70} Top Term: epsilon -``` \ No newline at end of file +```