A better README file #1079
A better README file #1079
Conversation
1. Corrected the spelling mistake -> (sigular to single) 2. Corrected the statement -> the number of dimensions is the rank of the array. 3. Made 2 more small changes.
for more information, see https://pre-commit.ci
…d the installation, and Hacking sections with code snippets.
…ME of Tensorflow.
…contributing Guidelines sections, (inspired from Numpy, Scipy's README).
…ram in the contributing Guidelines section.
|
Hi, everyone. I found that a few changes can be made to our README file to make it more better and useful for first-time viewers. After seeing the readme files of Tensorflow, Numpy...etc I made some changes to make our README file look better and more useful, I created this PR with those changes, any suggestions are welcome. So, you can merge it if you find it good. Also, please tell me if you want me to make any more changes to it, Thank you. |
…kdown-files in the root of the repository for any broken links. (It runs only once a week).
Co-authored-by: Claudia Comito <[email protected]>
There was a problem hiding this comment.
Thank you so much @Sai-Suraj-27 ! We're going to merge and make changes later if needed
|
Something is wrong with the CI matrix. A topic for our bore-a-thon @mtar ? |
There was a problem hiding this comment.
While we fix the CI matrix, a small change request. Thanks @Sai-Suraj-27 !
Will you merge it? 👀 |
Yes I will, sorry codecov! |
Updated the README file
Description
After Observing the README files of Tensorflow, NumPy, SciPy, and Pytorch. I thought these changes would make our README file much better.
Issue/s resolved: #1051
Changes proposed:
Type of change
Memory requirements
NA
Performance
NA
Due Diligence
Does this change modify the behaviour of other functions? If so, which?
No