Incomplete documentation - or: status and future of GMRES, JACOBI_L1...
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 692
- Forks
- 197
- PR merge metrics
- No merged PRs in 30d
Description
The current documentation (AMGX REFERENCE MANUAL October 2017) completely omits some solvers and smoothers, such as GMRES, JACOBI_L1, CHEBYSHEV and KACZMARZ.
I found the first three by going through the example configs, KACZMARZ seems to only be used in tests.
Does this mean these should be considered unsupported? For example, #28 hasn't been updated for a long time and since the docs don't mention GMRES, the limitation of preconditioner=NOSOLVER not working is not documented.
Since I'm currently getting very good results with the GMRES_AMG_D2 config, I would like to see these options available also in future versions and not having to worry about them being silently dropped.
Contributor guide
No contributing guide indexed for this repository
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 AMGX REFERENCE MANUAL October 2017 and compare its solver and smoother coverage with the example configs and tests, focusing on GMRES, JACOBI_L1, CHEBYSHEV, and KACZMARZ. Review issue #28 for the NOSOLVER limitation. Done means documenting the support status, availability, and known limitations of these options.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100