Update README.md

README.md

@@ -8,26 +8,11 @@ metrics:
 - accuracy
 library_name: keras
 ---
-# Embedding-model-16
+# English Embedding v.16 (Teeny-Tiny Castle)
 
-## Model Overview
+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. 
 
-The Embedding-model-16 is a language model for sentiment analysis.
-
-### Details
-
-- **Size:** 160,289  parameters
-- **Model type:** word embeddings
-- **Optimizer**: Adam
-- **Number of Epochs:** 20
-- **Embedding size:** 16
-- **Hardware:** Tesla V4
-- **Emissions:** Not measured
-- **Total Energy Consumption:** Not measured
-
-### How to Use
-
-To run inference on this model, you can use the following code snippet:
+## How to Use
 
 ```python
 import numpy as np
@@ -72,42 +57,5 @@ for i, word in enumerate(english_embedding_vocabulary):
 
 print("Embeddings Dimensions: ", np.array(list(words_embeddings.values())).shape)
 print("Vocabulary Size: ", len(words_embeddings.keys()))
-```
-## Intended Use
-
-This model was created for research purposes only. We do not recommend any application of this model outside this scope.
-
-## Performance Metrics
-
-The model achieved an accuracy of 84% on validation data.
 
-## Training Data
-
-The model was trained using a dataset that was put together by combining several datasets for sentiment classification available on [Kaggle](https://www.kaggle.com/):
-
-- The `IMDB 50K` [dataset](https://www.kaggle.com/datasets/lakshmi25npathi/imdb-dataset-of-50k-movie-reviews?select=IMDB+Dataset.csv): _0K movie reviews for natural language processing or Text analytics._
-- The `Twitter US Airline Sentiment` [dataset](https://www.kaggle.com/datasets/crowdflower/twitter-airline-sentiment): _originated from the  [Crowdflower's Data for Everyone library](http://www.crowdflower.com/data-for-everyone)._
-- Our `google_play_apps_review` _dataset: built using the `google_play_scraper` in [this notebook](https://github.com/Nkluge-correa/teeny-tiny_castle/blob/master/ML%20Explainability/NLP%20Interpreter%20(en)/scrape(en).ipynb)._
-- The `EcoPreprocessed` [dataset](https://www.kaggle.com/datasets/pradeeshprabhakar/preprocessed-dataset-sentiment-analysis): _scrapped amazon product reviews_.
-
-## Limitations
-
-We do not recommend using this model in real-world applications. It was solely developed for academic and educational purposes.
-
-## Cite as
-
-```latex
-@misc{teenytinycastle,
-    doi = {10.5281/zenodo.7112065},
-    url = {https://github.com/Nkluge-correa/teeny-tiny_castle},
-    author = {Nicholas Kluge Corr{\^e}a},
-    title = {Teeny-Tiny Castle},
-    year = {2024},
-    publisher = {GitHub},
-    journal = {GitHub repository},
-}
 ```
-
-## License
-
-This model is licensed under the Apache License, Version 2.0.