Refactors and updates sphinx documantation #183
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
StephenNneji
commented
Dec 1, 2023
StephenNneji
commented
- Updates packages for building docs
- Makes an initial attempt to put the API documentation in order
- Updates installation information
DrPaulSharp
reviewed
Dec 1, 2023
| 2. **Differential Evolution** - Optimizes a problem by iteratively improving a candidate solution based on an evolutionary process | ||
| 3. **Nested Sampler** - Estimates directly how the likelihood function relates to prior mass | ||
| 4. **DREAM** | ||
| 5. **Calculate** |
There was a problem hiding this comment.
We have procedures named as "de" and "ns" in the procedures enum. Should we change these to Differential evolution and nested sampler instead?
There was a problem hiding this comment.
I will add the NS and DE in brackets in the docs for now we can make the refactor in another PR
docs/source/controlClass.rst
Outdated
| automatically updated based on the procedure selected. | ||
|
|
||
| RAT uses parallelization to speed up the calculation. This is achieved using Parallel Computing Toolbox. The user can choose to use the parallelization or not and | ||
| if yes, what to parallelize on. (Points or Contrasts or all) |
There was a problem hiding this comment.
Should be clearer that "all" means both points and contrasts here.
There was a problem hiding this comment.
I am not sure "all" means both and now looking at the code "all" is never used
DrPaulSharp
approved these changes
Dec 1, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.