Update README.md

README.md

@@ -1,199 +1,109 @@
 ---
 library_name: transformers
-tags: []
+license: apache-2.0
 ---
 
-# Model Card for Model ID
+# Test Log 08 March 2025
+
+### First Test:
+Mean Perplexity : tested on `wikitext-2-raw-v1`, ~2k English samples was `1391.7575478298118`
+
+### Second Test
+Evaluated the tokenizer's performance on:
+- Unicode coverage.
+- Token distribution.
+- Tokenization complexity across different scripts.
+- Encoding and decoding capabilities &
+- Edge cases e.g., special characters, numbers, etc.
+- 1k samples: 500 Hindi, 500 English
+
+### 1. Edge Case Handling
+
+| **Language** | **Test Type**      | **Token Count** | **Unique Tokens** |
+|--------------|--------------------|-----------------|-------------------|
+| **Hindi**    | Script Test        | 14              | 13                |
+|              | Unicode Test       | 21              | 21                |
+|              | Special Characters | 19              | 19                |
+| **English**  | Script Test        | 16              | 15                |
+|              | Unicode Test       | 14              | 14                |
+|              | Special Characters | 18              | 18                |
+
+### 2. Unicode Coverage
+
+| **Language** | **Coverage Ratio** | **Token Count** | **Unique Tokens** |
+|--------------|--------------------|-----------------|-------------------|
+| **Hindi**    | 100%               | 21              | 21                |
+| **English**  | 100%               | 14              | 14                |
+
+### 3. Complexity
+
+| **Language** | **Original Length** | **Token Count** | **Avg Token Length** | **Token Diversity** |
+|--------------|---------------------|-----------------|----------------------|---------------------|
+| **Hindi**    | 49                  | 14              | 9.07                 | 0.928               |
+| **English**  | 65                  | 16              | 4.06                 | 0.937   
+
+
+### 4. Encoding-Decoding Capabilities
+```
+Hindi Analysis:
+Original Text: नमस्ते, मैं भारत से हूँ। दिल्ली बहुत बड़ा शहर है।
+Token IDs Count: 14
+Token Strings: ['नम', 'सà¥įतà¥ĩ', ',', 'Ġमà¥Īà¤Ĥ', 'Ġà¤Ńारत', 'Ġसà¥ĩ', 'Ġहà¥Ĥà¤ģ', '।', 'Ġदिलà¥įलà¥Ģ', 'Ġबहà¥ģत', 'Ġबड़ा', 'Ġशहर', 'Ġहà¥Ī', '।']
+Decoded Text: नमस्ते, मैं भारत से हूँ। दिल्ली बहुत बड़ा शहर है।
+Text Reconstruction: True
+
+Hindi Analysis:
+Original Text: हिंदी भाषा बहुत सुंदर है।
+Token IDs Count: 7
+Token Strings: ['ह', 'िà¤Ĥदà¥Ģ', 'Ġà¤Ńाषा', 'Ġबहà¥ģत', 'Ġसà¥ģà¤Ĥदर', 'Ġहà¥Ī', '।']
+Decoded Text: हिंदी भाषा बहुत सुंदर है।
+Text Reconstruction: True
+
+Hindi Analysis:
+Original Text: मुझे किताबें पढ़ना पसंद है।
+Token IDs Count: 7
+Token Strings: ['म', 'à¥ģà¤Ŀà¥ĩ', 'Ġà¤ķिताबà¥ĩà¤Ĥ', 'Ġपढ़ना', 'Ġपसà¤Ĥद', 'Ġहà¥Ī', '।']
+Decoded Text: मुझे किताबें पढ़ना पसंद है।
+Text Reconstruction: True
+
+Hindi Analysis:
+Original Text: यह एक उदाहरण वाक्य है।
+Token IDs Count: 6
+Token Strings: ['यह', 'Ġà¤ıà¤ķ', 'Ġà¤īदाहरण', 'Ġवाà¤ķà¥įय', 'Ġहà¥Ī', '।']
+Decoded Text: यह एक उदाहरण वाक्य है।
+Text Reconstruction: True
+
+English Analysis:
+Original Text: Hello, I am from India. Delhi is a big city.
+Token IDs Count: 13
+Token Strings: ['Hello', ',', 'ĠI', 'Ġam', 'Ġfrom', 'ĠIndia', '.', 'ĠDelhi', 'Ġis', 'Ġa', 'Ġbig', 'Ġcity', '.']
+Decoded Text: Hello, I am from India. Delhi is a big city.
+Text Reconstruction: True
+
+English Analysis:
+Original Text: The English language is widely spoken.
+Token IDs Count: 7
+Token Strings: ['The', 'ĠEnglish', 'Ġlanguage', 'Ġis', 'Ġwidely', 'Ġspoken', '.']
+Decoded Text: The English language is widely spoken.
+Text Reconstruction: True
+
+English Analysis:
+Original Text: I enjoy reading books.
+Token IDs Count: 5
+Token Strings: ['I', 'Ġenjoy', 'Ġreading', 'Ġbooks', '.']
+Decoded Text: I enjoy reading books.
+Text Reconstruction: True
+
+English Analysis:
+Original Text: This is an example sentence.
+Token IDs Count: 6
+Token Strings: ['This', 'Ġis', 'Ġan', 'Ġexample', 'Ġsentence', '.']
+Decoded Text: This is an example sentence.
+Text Reconstruction: True
+```
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/650a93c23449d9a49c356aab/YgyuDih3GCBIWpD_mJNhE.png)
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/650a93c23449d9a49c356aab/IAsX-K3UDXc0R3g6m52_e.png)
 
-<!-- Provide a quick summary of what the model is/does. -->
 
-
-
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]