Update README.md

README.md

@@ -7,36 +7,56 @@ metrics:
 - accuracy
 pipeline_tag: image-classification
 ---
-# Model Description
+# Digit-classifier
+
+## Model Overview
 
 The digit-classifier model is used to recognize manuscript digits from 0 to 9.
 
-The model was trained with the [MNIST digits classification dataset](https://keras.io/api/datasets/mnist/).
+### Details
 
-## Details
-- Size: 1,256,080 parameters
-- Dataset: [tf.keras.datasets.mnist](https://storage.googleapis.com/tensorflow/tf-keras-datasets/mnist.npz)
-- Language: English
-- Number of Epochs: 10
-- Batch size: 32
-- Optimizer: Adam (tf.keras.optimizers.Adam(learning_rate=0.001)
-- Hardware: Tesla T4
-- This repository has the source [code used](https://github.com/Nkluge-correa/teeny-tiny_castle/blob/master/ML%20Intro%20Course/19_quick_AI_app.ipynb) to train this model.
+- **Size:**  1,256,080  parameters
+- **Model type:** Convolutional neural network
+- **Optimizer**:  tf.keras.optimizers.Adam(learning_rate=0.001)
+- **Number of Epochs:** 10
+- **Batch size:** 256
+- **Hardware:** Tesla V4
+- **Emissions:** Not measured
+- **Total Energy Consumption:** Not measured
 
-# Cite as 🤗
+### How to Use
+
+```python
+from huggingface_hub import from_pretrained_keras
 
+model = from_pretrained_keras("AiresPucrs/digit-classifier")
+
+classes = ['zero', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine']
 ```
+
+## Intended Use
+
+This model was created for research purposes only. Specifically, it was designed to recognize manuscript digits from 0 to 9. We do not recommend any application of this model outside this scope.
+
+
+## Training Data
+
+The model was trained with the [MNIST digits classification dataset](https://keras.io/api/datasets/mnist/).
+
+
+# Cite as 🤗
+```latex
 @misc{teenytinycastle,
     doi = {10.5281/zenodo.7112065},
-    url = {https://huggingface.co/AiresPucrs/digit-classifier},
+    url = {https://github.com/Nkluge-correa/teeny-tiny_castle},
     author = {Nicholas Kluge Corr{\^e}a},
     title = {Teeny-Tiny Castle},
-    year = {2023},
-    publisher = {HuggingFace},
-    journal = {HuggingFace repository},
+    year = {2024},
+    publisher = {GitHub},
+    journal = {GitHub repository},
 }
 ```
-
 ## License
 
-The digit-classifier is licensed under the Apache License, Version 2.0. See the LICENSE file for more details.
+
+This model is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.