Skip to content

doc: Add troubleshooting for known issues #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asamal4 merged 1 commit into from
Dec 30, 2025
Merged

doc: Add troubleshooting for known issues #126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,13 @@ make bandit # Security scanning
make test # Or: uv run pytest tests --cov=src
```

## 🔧 Troubleshooting

| Issue | Solution |
|-------|----------|
| Parsing error with context-related metrics (e.g., `faithfulness`) | Increase [`max_tokens`](config/system.yaml#L16) to a higher value (e.g., 2048 or higher - depends on number of the context & size) |
| API responses not changing after updates | Disable caching (`cache_enabled: false`) or delete the cache folders (`.caches/`) |

## Generate answers (optional - for creating test data)
For generating answers (optional) refer [README-generate-answers](README-generate-answers.md)

Expand Down
Loading