Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] added README for MNIST #68

Closed
wants to merge 4 commits into from
Closed

Conversation

codeboy5
Copy link

@codeboy5 codeboy5 commented Mar 25, 2020

I have added a README for the dataset and how to process it to be used in the models.
@kartikdutt18 Kindly go through this and let me know what can I improve on.
As discussed in #65

@mlpack-bot
Copy link

mlpack-bot bot commented Mar 25, 2020

Thanks for opening your first pull request in this repository! Someone will review it when they have a chance. In the mean time, please be sure that you've handled the following things, to make the review process quicker and easier:

  • All code should follow the style guide
  • Documentation added for any new functionality
  • Tests added for any new functionality
  • Tests that are added follow the testing guide
  • Headers and license information added to the top of any new code files
  • HISTORY.md updated if the changes are big or user-facing
  • All CI checks should be passing

Thank you again for your contributions! 👍

Copy link
Member

@kartikdutt18 kartikdutt18 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @codeboy5, awesome work. Some handful comments. Let me know what you think. I will gives this a more in depth review tomorrow morning. Thanks a lot 💯

MNIST dataset contains images of handwritten digits. It is one of the most common datasets used for image classifcation. It has 60,000 28x28 grayscale images under the training set and 10,000 28x28 grayscale images under the test set. Each pixel has a value between 0 and 255.

![alt text](https://upload.wikimedia.org/wikipedia/commons/2/27/MnistExamples.png "Sample Images From The MNIST Database")
*Sample Images From The MNIST Database*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we have this in a separate line ?
Also The images might look better with centre alignment. Is there any way to do that?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I found a way online, would try it and see.

Kaggle/README.md Outdated

##### 1. DigitRecognizer
For More Details related to the Model, check out the **DigitRecognizer** Directory.
After running the model for 50 cycles, I was able to obtain the best validation set accuracy of **97.2143%**.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of using I here can we use one here?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the model would be more apt I believe

### Processing The Dataset

##### 1. Loading The Dataset From The File To A Useable Format
The Load Class is used to load a matrix from the file.The type of file is guessed automatically from the extension. For a list of supported file types please refer to [Load Class](https://github.com/mlpack/mlpack/blob/master/src/mlpack/core/data/load.hpp). Please note that since mlpack requires matrices to be in column major format and usually data is stored in a row major format, the matrix by default is transposed. In case the data is originally in column major format, consider setting the parameter to False. Refer to documentation of Load Class for further information.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do this we could add a code snippet here that shows this function loading mnist.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for below.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure that would be beneficial, would make that change.

@codeboy5 codeboy5 closed this Mar 26, 2020
@codeboy5 codeboy5 deleted the add-doc branch March 26, 2020 06:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants