Update RTD to support new users #249
Merged
Conversation
This file contains hidden or 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
- Put Fiji in the quick start section since this is how we expect people to interact with Ops - Focus the how-to guides to cover usage in-depth - Move benchmarks to Development since because of the technical scope of this section
Add some info on creating an OpEnvironment and add more words to clarify API usage.
- Expand to cover Function and InPlace options - Reword for clarity
ctrueden
approved these changes
Jul 31, 2024
| Note that although the final method call changes for each mode of operation, *this is based on the path taken through the `OpBuilder` chain*. For example, we cannot call the `compute()` method if we haven't provided an `.output()`: | ||
|
|
||
| ``` | ||
| # Does not compute |
| ```text | ||
| filter.gauss: | ||
| - (input, sigmas, @CONTAINER container1) -> None | ||
| - (input, sigmas, outOfBounds = null, @CONTAINER container1) -> None |
Member
There was a problem hiding this comment.
Not part of this PR I know, but this output mixes nulls and Nones... we should make that more consistent.
gselzer
reviewed
Jul 31, 2024
| With the name established in the `OpBuilder` chain, we can then specify our input(s) with the `.input()` method. | ||
|
|
||
| For our gaussian blur, we will pass as inputs our input image `inImage`, and a `double` as our sigma parameter: | ||
| For this Gaussian blur, we have two inputs: `inImage` is the image we want to blur, and a `double` value as our sigma parameter: |
Member
There was a problem hiding this comment.
Suggested change
| For this Gaussian blur, we have two inputs: `inImage` is the image we want to blur, and a `double` value as our sigma parameter: | |
| For this Gaussian blur, we have two inputs: `inImage` is the image we want to blur, and a `double` value as the standard deviation of the smoothing function: |
What do you think about using the technical term?
Member
There was a problem hiding this comment.
I like the simpler our sigma parameter 😉
| var outImage = ops.op("filter.gauss").input(inImage, 2.0).apply() | ||
| ``` | ||
|
|
||
| *Inplaces* are used when we want to destructively modify one of the existing inputs (which is explicitly forbidden by *computers*; a *computer* Op's output should be a different object from all of its inputs). We indicate this by the `mutate#()` method, where the `#` corresponds to the *parameter index* that will be modified: |
Member
There was a problem hiding this comment.
Would it be confusing, or clarifying, to note this is 1-indexed?
| *Note that the default `OpEnvironment` implementations cache Op requests* - this means that repeated `OpBuilder` requests targeting the same action will be faster than the original matching call. | ||
|
|
||
| ## Additions: Matching with classes | ||
| ### Matching with classes |
Member
There was a problem hiding this comment.
Is classes better or worse than types?
Member
ctrueden
added a commit
that referenced
this pull request
Jul 31, 2024
Make further updates based on feedback from PR #249
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.
These changes restructure the introductory sections of the read the docs pages to get users into Ops use relatively smoothly (hopefully) by tuning the
Getting Startedsection to be more of a "quick start" into scripting, while focusing and fleshing out the "how-to guides" section, e.g. by prioritizing finding Ops before calling them and adding missing information onFunctionsandInplaces.