Updating documentation of pyttb.tensor.from_function.
#425
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
Added an example showing how to create a tensor with normal random entries, for which there is no current shortcut like `tenones`. Used that example to show how it's arguably best to pass in a vector rather than trying to worry about forcing Fortran ordering. Also updated the example of create an all ones tensor. The previous documentation relied on some function called `fortran_order_one`, and I'm not sure what that is. Instead, I changed it to the `numpy.ones` function and to specify the fortran order via its interface. I think these examples will be more helpful to users.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
tenones.fortran_order_one, and I'm not sure what that is.numpy.onesfunction and to specify the fortran order via its interface.I think these examples will be helpful to users.
📚 Documentation preview 📚: https://pyttb--425.org.readthedocs.build/en/425/