TimefoldAI / TimefoldAI/timefold-solver
docs: improve documentation for troubleshooting
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.8k
- Forks
- 228
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 46
Description
We are seeing some users jump to complex metaheuristic constructions to improve solver speed. We are missing some guidance on how to solve performance problems / improving the solver results.
We do have a page that discusses performance, but it apparently doesn't get enough attention from our users: https://docs.timefold.ai/timefold-solver/latest/constraints-and-score/performance
Highlight this troubleshooting structure:
- Check constraint implementation
- Use a custom move
- Setup different metaheuristics (and if you do, benchmark on large dataset)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing performance page at https://docs.timefold.ai/timefold-solver/latest/constraints-and-score/performance and review how its guidance is organized. Add the requested troubleshooting structure covering constraint implementation, custom moves, and metaheuristics with benchmarking on large datasets; done means users can find and follow these performance steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100