Improve and expand README documentation for NDArray examples#1098
Open
NA-V10 wants to merge 2 commits intodeeplearning4j:masterfrom
Open
Improve and expand README documentation for NDArray examples#1098NA-V10 wants to merge 2 commits intodeeplearning4j:masterfrom
NA-V10 wants to merge 2 commits intodeeplearning4j:masterfrom
Conversation
Contributor
|
Try to clean this up and add back some more of the context that was there rather than just overriding something completely. I certainly don't mind better clarifying explanations of things though! Again thanks for the contributions! |
Contributor
Author
|
Thank you for the review! |
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
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.
This PR improves the documentation for the nd4j-ndarray-examples module.
✔ What was added
Expanded README with a clear explanation of what an NDArray is
Updated usage guide for INDArray operations
Added runnable code examples for:
NDArray creation
Arithmetic operations
Reshaping and broadcasting
Included instructions for running the examples with Maven
Added expected output to help beginners understand behavior
✔ Why this is useful
The previous README was minimal and did not explain:
What NDArray is
How to run the examples
What each operation does
This PR makes the module easier to understand for:
Beginners learning DL4J
Students exploring NDArray fundamentals
New contributors who want to verify expected behavior
✔ Notes
No code changes — documentation only.
Safe update, no breaking changes.