nicholasKluge commited on
Commit
48f8d85
1 Parent(s): 446357e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -45
README.md CHANGED
@@ -7,56 +7,14 @@ metrics:
7
  - accuracy
8
  pipeline_tag: image-classification
9
  ---
10
- # Digit-classifier
11
 
12
- ## Model Overview
13
 
14
- The digit-classifier model is used to recognize manuscript digits from 0 to 9.
15
-
16
- ### Details
17
-
18
- - **Size:** 1,256,080 parameters
19
- - **Model type:** Convolutional neural network
20
- - **Optimizer**: tf.keras.optimizers.Adam(learning_rate=0.001)
21
- - **Number of Epochs:** 10
22
- - **Batch size:** 256
23
- - **Hardware:** Tesla V4
24
- - **Emissions:** Not measured
25
- - **Total Energy Consumption:** Not measured
26
-
27
- ### How to Use
28
 
29
  ```python
30
  from huggingface_hub import from_pretrained_keras
31
 
32
  model = from_pretrained_keras("AiresPucrs/digit-classifier")
33
-
34
- classes = ['zero', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine']
35
- ```
36
-
37
- ## Intended Use
38
-
39
- 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.
40
-
41
-
42
- ## Training Data
43
-
44
- The model was trained with the [MNIST digits classification dataset](https://keras.io/api/datasets/mnist/).
45
-
46
-
47
- # Cite as 🤗
48
- ```latex
49
- @misc{teenytinycastle,
50
- doi = {10.5281/zenodo.7112065},
51
- url = {https://github.com/Nkluge-correa/teeny-tiny_castle},
52
- author = {Nicholas Kluge Corr{\^e}a},
53
- title = {Teeny-Tiny Castle},
54
- year = {2024},
55
- publisher = {GitHub},
56
- journal = {GitHub repository},
57
- }
58
  ```
59
- ## License
60
-
61
-
62
- This model is licensed under the Apache License, Version 2.0.
 
7
  - accuracy
8
  pipeline_tag: image-classification
9
  ---
10
+ # Digit Classifier (Teeny-Tiny Castle)
11
 
12
+ This model is part of a tutorial tied to the [Teeny-Tiny Castle](https://github.com/Nkluge-correa/TeenyTinyCastle), an open-source repository containing educational tools for AI Ethics and Safety research.
13
 
14
+ ## How to Use
 
 
 
 
 
 
 
 
 
 
 
 
 
15
 
16
  ```python
17
  from huggingface_hub import from_pretrained_keras
18
 
19
  model = from_pretrained_keras("AiresPucrs/digit-classifier")
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
20
  ```