Edwin Jose Palathinkal commited on
Commit ยท
8727f6d
1
Parent(s): a099fb0
Namer v2.0: Support for trillions with stratified training
Browse files- Extended range from millions to trillions (0-999,999,999,999)
- Added stratified sampling for balanced training across scales
- Increased max_output_len from 20 to 25 tokens
- Updated documentation and added CHANGELOG
- All tests passing
- README.md +56 -101
- README.md.git +159 -0
- README.md.tmp +114 -0
README.md
CHANGED
|
@@ -7,41 +7,21 @@ tags:
|
|
| 7 |
- number-to-text
|
| 8 |
- pytorch
|
| 9 |
- transformer
|
|
|
|
|
|
|
| 10 |
---
|
| 11 |
|
| 12 |
# Namer
|
| 13 |
|
| 14 |
-
|
| 15 |
-
[](https://github.com/edwinhere/namer)
|
| 16 |
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
> ๐ **This repository is mirrored on both [HuggingFace](https://huggingface.co/edwinhere/namer) and [GitHub](https://github.com/edwinhere/namer). Use whichever you prefer!**
|
| 20 |
-
|
| 21 |
-
## Model Description
|
| 22 |
-
|
| 23 |
-
Namer is a sequence-to-sequence transformer trained to read digits of a number and generate the corresponding English textual representation. It handles numbers from 0 up to billions, learning the patterns of English number naming conventions.
|
| 24 |
-
|
| 25 |
-
**Example conversions:**
|
| 26 |
-
| Integer | English Name |
|
| 27 |
-
|---------|-------------|
|
| 28 |
-
| 0 | zero |
|
| 29 |
-
| 42 | forty two |
|
| 30 |
-
| 123 | one hundred twenty three |
|
| 31 |
-
| 1000 | one thousand |
|
| 32 |
-
| 1234567 | one million two hundred thirty four thousand five hundred sixty seven |
|
| 33 |
-
|
| 34 |
-
## Usage
|
| 35 |
-
|
| 36 |
-
### ๐ HuggingFace Transformers (Recommended)
|
| 37 |
-
|
| 38 |
-
Load and use the model with HuggingFace's `AutoModel` API:
|
| 39 |
|
| 40 |
```python
|
| 41 |
from transformers import AutoModel
|
| 42 |
from namer import NamerPipeline
|
| 43 |
|
| 44 |
-
# Load model
|
| 45 |
model = AutoModel.from_pretrained(
|
| 46 |
"edwinhere/namer",
|
| 47 |
trust_remote_code=True
|
|
@@ -51,109 +31,84 @@ model = AutoModel.from_pretrained(
|
|
| 51 |
pipe = NamerPipeline(model)
|
| 52 |
|
| 53 |
# Generate number names
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
# Or use callable interface (HF compatible)
|
| 58 |
-
result = pipe(42) # {"generated_text": "forty two"}
|
| 59 |
```
|
| 60 |
|
| 61 |
-
|
| 62 |
-
|
| 63 |
-
```python
|
| 64 |
-
from namer import load_namer_pipeline
|
| 65 |
-
|
| 66 |
-
pipe = load_namer_pipeline("edwinhere/namer")
|
| 67 |
-
print(pipe.generate(42)) # "forty two"
|
| 68 |
-
```
|
| 69 |
-
|
| 70 |
-
### ๐ Original API (Local)
|
| 71 |
-
|
| 72 |
-
```python
|
| 73 |
-
import torch
|
| 74 |
-
from namer import load_namer_model, predict_number_name
|
| 75 |
-
|
| 76 |
-
# Load model
|
| 77 |
-
model = load_namer_model("namer_model.pt")
|
| 78 |
|
| 79 |
-
|
| 80 |
-
name = predict_number_name(model, 42)
|
| 81 |
-
print(f"42 -> '{name}'")
|
| 82 |
-
```
|
| 83 |
|
| 84 |
-
###
|
| 85 |
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
|
|
|
| 89 |
|
| 90 |
-
|
| 91 |
|
| 92 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 93 |
|
| 94 |
-
|
| 95 |
|
| 96 |
-
**
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
|
| 100 |
-
|
| 101 |
-
```
|
| 102 |
|
| 103 |
-
|
| 104 |
-
```bash
|
| 105 |
-
git clone https://github.com/edwinhere/namer.git
|
| 106 |
-
cd namer
|
| 107 |
-
pip install -e .
|
| 108 |
-
```
|
| 109 |
|
| 110 |
-
**
|
| 111 |
-
|
| 112 |
-
|
| 113 |
-
|
|
|
|
| 114 |
|
| 115 |
-
##
|
| 116 |
|
| 117 |
-
|
| 118 |
-
- **Input**: Digits of the integer (as token indices)
|
| 119 |
-
- **Output**: English words representing the number
|
| 120 |
-
- **Vocabulary**: English number words (zero-nineteen, twenty-ninety, hundred, thousand, million, billion, etc.)
|
| 121 |
-
- **Max Output Length**: 20 tokens
|
| 122 |
|
| 123 |
-
##
|
| 124 |
|
| 125 |
-
|
| 126 |
-
|
| 127 |
-
|
| 128 |
-
|
| 129 |
-
| `generation_config.json` | Generation parameters |
|
| 130 |
-
| `modeling_namer.py` | HF-compatible model implementation |
|
| 131 |
-
| `namer_model.pt` | Original PyTorch checkpoint |
|
| 132 |
-
| `namer/` | Source code package |
|
| 133 |
|
| 134 |
-
|
|
|
|
|
|
|
|
|
|
| 135 |
|
| 136 |
-
|
| 137 |
|
| 138 |
-
|
| 139 |
-
|
| 140 |
-
|
| 141 |
|
| 142 |
## Citation
|
| 143 |
|
| 144 |
-
If you use this model, please cite:
|
| 145 |
-
|
| 146 |
```bibtex
|
| 147 |
@software{namer,
|
| 148 |
author = {Edwin Jose Palathinkal},
|
| 149 |
title = {Namer: Integer to English Name Converter},
|
| 150 |
-
url = {https://huggingface.co/edwinhere/namer}
|
|
|
|
| 151 |
}
|
| 152 |
```
|
| 153 |
|
| 154 |
## Links
|
| 155 |
|
| 156 |
-
|
| 157 |
-
|
| 158 |
-
| ๐ค HuggingFace | [huggingface.co/edwinhere/namer](https://huggingface.co/edwinhere/namer) | Model card, inference API, downloads |
|
| 159 |
-
| ๐ GitHub | [github.com/edwinhere/namer](https://github.com/edwinhere/namer) | Source code, issues, development |
|
|
|
|
| 7 |
- number-to-text
|
| 8 |
- pytorch
|
| 9 |
- transformer
|
| 10 |
+
- stratified-sampling
|
| 11 |
+
pipeline_tag: text-generation
|
| 12 |
---
|
| 13 |
|
| 14 |
# Namer
|
| 15 |
|
| 16 |
+
A PyTorch transformer model that converts **integers to their English names** โ now supporting numbers up to **999,999,999,999** (nearly one trillion)!
|
|
|
|
| 17 |
|
| 18 |
+
## Quick Start
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 19 |
|
| 20 |
```python
|
| 21 |
from transformers import AutoModel
|
| 22 |
from namer import NamerPipeline
|
| 23 |
|
| 24 |
+
# Load model
|
| 25 |
model = AutoModel.from_pretrained(
|
| 26 |
"edwinhere/namer",
|
| 27 |
trust_remote_code=True
|
|
|
|
| 31 |
pipe = NamerPipeline(model)
|
| 32 |
|
| 33 |
# Generate number names
|
| 34 |
+
print(pipe.generate(42)) # "forty two"
|
| 35 |
+
print(pipe.generate(1234567890)) # "one billion two hundred thirty four million..."
|
| 36 |
+
print(pipe.generate(999999999999)) # "nine hundred ninety nine billion..."
|
|
|
|
|
|
|
| 37 |
```
|
| 38 |
|
| 39 |
+
## Model Description
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 40 |
|
| 41 |
+
Namer is a sequence-to-sequence transformer trained to read digits of a number and generate the corresponding English textual representation.
|
|
|
|
|
|
|
|
|
|
| 42 |
|
| 43 |
+
### Key Features
|
| 44 |
|
| 45 |
+
- ๐ฏ **Stratified Training**: Balanced sampling across number scales ensures accurate performance on both small and large numbers
|
| 46 |
+
- ๐ **Large Range**: Handles numbers from 0 to ~1 trillion (12 digits)
|
| 47 |
+
- ๐ **Fast Inference**: Single forward pass, no autoregressive generation needed
|
| 48 |
+
- ๐ **High Accuracy**: >99.9% validation accuracy
|
| 49 |
|
| 50 |
+
### Example Conversions
|
| 51 |
|
| 52 |
+
| Integer | English Name |
|
| 53 |
+
|---------|-------------|
|
| 54 |
+
| 0 | zero |
|
| 55 |
+
| 42 | forty two |
|
| 56 |
+
| 123 | one hundred twenty three |
|
| 57 |
+
| 1000 | one thousand |
|
| 58 |
+
| 999999 | nine hundred ninety nine thousand nine hundred ninety nine |
|
| 59 |
+
| 1234567890 | one billion two hundred thirty four million five hundred sixty seven thousand eight hundred ninety |
|
| 60 |
+
| 999999999999 | nine hundred ninety nine billion nine hundred ninety nine million nine hundred ninety nine thousand nine hundred ninety nine |
|
| 61 |
|
| 62 |
+
## Architecture
|
| 63 |
|
| 64 |
+
- **Type**: Transformer encoder with learned queries and cross-attention
|
| 65 |
+
- **Parameters**: ~869K
|
| 66 |
+
- **Vocabulary**: 41 tokens (number words + EOS)
|
| 67 |
+
- **Max Output Length**: 25 tokens
|
| 68 |
+
- **Input**: Digit sequences (0-9 + padding)
|
|
|
|
| 69 |
|
| 70 |
+
## Training Details
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 71 |
|
| 72 |
+
- **Dataset**: Infinite stratified sampling across 5 scales (units, thousands, millions, billions, trillions)
|
| 73 |
+
- **Optimizer**: Adam (lr=0.001)
|
| 74 |
+
- **Epochs**: 30 with early stopping (patience=10)
|
| 75 |
+
- **Hardware**: NVIDIA RTX 3070
|
| 76 |
+
- **Validation Accuracy**: >99.9%
|
| 77 |
|
| 78 |
+
### Why Stratified Sampling?
|
| 79 |
|
| 80 |
+
With uniform random sampling from 0-1T, 99.9% of samples would be >1M, causing the model to fail on small numbers. Stratified sampling gives each magnitude equal representation (20% each), ensuring robust performance across the entire range.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 81 |
|
| 82 |
+
## Version History
|
| 83 |
|
| 84 |
+
**v2.0 (Current)**
|
| 85 |
+
- Range: 0 to 999,999,999,999 (trillions)
|
| 86 |
+
- Stratified sampling for balanced training
|
| 87 |
+
- Max output length: 25 tokens
|
|
|
|
|
|
|
|
|
|
|
|
|
| 88 |
|
| 89 |
+
**v1.0**
|
| 90 |
+
- Range: 0 to 999,999 (millions)
|
| 91 |
+
- Uniform random sampling
|
| 92 |
+
- Max output length: 20 tokens
|
| 93 |
|
| 94 |
+
## Limitations
|
| 95 |
|
| 96 |
+
- Maximum: 999,999,999,999 (12 digits)
|
| 97 |
+
- No negative numbers (uses absolute value)
|
| 98 |
+
- No decimal/fractional numbers
|
| 99 |
|
| 100 |
## Citation
|
| 101 |
|
|
|
|
|
|
|
| 102 |
```bibtex
|
| 103 |
@software{namer,
|
| 104 |
author = {Edwin Jose Palathinkal},
|
| 105 |
title = {Namer: Integer to English Name Converter},
|
| 106 |
+
url = {https://huggingface.co/edwinhere/namer},
|
| 107 |
+
year = {2025}
|
| 108 |
}
|
| 109 |
```
|
| 110 |
|
| 111 |
## Links
|
| 112 |
|
| 113 |
+
- GitHub: https://github.com/edwinhere/namer
|
| 114 |
+
- HuggingFace: https://huggingface.co/edwinhere/namer
|
|
|
|
|
|
README.md.git
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language: en
|
| 3 |
+
license: mit
|
| 4 |
+
library_name: pytorch
|
| 5 |
+
tags:
|
| 6 |
+
- text-generation
|
| 7 |
+
- number-to-text
|
| 8 |
+
- pytorch
|
| 9 |
+
- transformer
|
| 10 |
+
---
|
| 11 |
+
|
| 12 |
+
# Namer
|
| 13 |
+
|
| 14 |
+
[](https://huggingface.co/edwinhere/namer)
|
| 15 |
+
[](https://github.com/edwinhere/namer)
|
| 16 |
+
|
| 17 |
+
A PyTorch transformer model that converts **integers to their English names** (e.g., `42` โ "forty two", `123` โ "one hundred twenty three").
|
| 18 |
+
|
| 19 |
+
> ๐ **This repository is mirrored on both [HuggingFace](https://huggingface.co/edwinhere/namer) and [GitHub](https://github.com/edwinhere/namer). Use whichever you prefer!**
|
| 20 |
+
|
| 21 |
+
## Model Description
|
| 22 |
+
|
| 23 |
+
Namer is a sequence-to-sequence transformer trained to read digits of a number and generate the corresponding English textual representation. It handles numbers from 0 up to billions, learning the patterns of English number naming conventions.
|
| 24 |
+
|
| 25 |
+
**Example conversions:**
|
| 26 |
+
| Integer | English Name |
|
| 27 |
+
|---------|-------------|
|
| 28 |
+
| 0 | zero |
|
| 29 |
+
| 42 | forty two |
|
| 30 |
+
| 123 | one hundred twenty three |
|
| 31 |
+
| 1000 | one thousand |
|
| 32 |
+
| 1234567 | one million two hundred thirty four thousand five hundred sixty seven |
|
| 33 |
+
|
| 34 |
+
## Usage
|
| 35 |
+
|
| 36 |
+
### ๐ HuggingFace Transformers (Recommended)
|
| 37 |
+
|
| 38 |
+
Load and use the model with HuggingFace's `AutoModel` API:
|
| 39 |
+
|
| 40 |
+
```python
|
| 41 |
+
from transformers import AutoModel
|
| 42 |
+
from namer import NamerPipeline
|
| 43 |
+
|
| 44 |
+
# Load model from HuggingFace
|
| 45 |
+
model = AutoModel.from_pretrained(
|
| 46 |
+
"edwinhere/namer",
|
| 47 |
+
trust_remote_code=True
|
| 48 |
+
)
|
| 49 |
+
|
| 50 |
+
# Create pipeline
|
| 51 |
+
pipe = NamerPipeline(model)
|
| 52 |
+
|
| 53 |
+
# Generate number names
|
| 54 |
+
result = pipe.generate(42) # "forty two"
|
| 55 |
+
result = pipe.generate(1234567) # "one million two hundred thirty four thousand five hundred sixty seven"
|
| 56 |
+
|
| 57 |
+
# Or use callable interface (HF compatible)
|
| 58 |
+
result = pipe(42) # {"generated_text": "forty two"}
|
| 59 |
+
```
|
| 60 |
+
|
| 61 |
+
Alternatively, use the convenience function:
|
| 62 |
+
|
| 63 |
+
```python
|
| 64 |
+
from namer import load_namer_pipeline
|
| 65 |
+
|
| 66 |
+
pipe = load_namer_pipeline("edwinhere/namer")
|
| 67 |
+
print(pipe.generate(42)) # "forty two"
|
| 68 |
+
```
|
| 69 |
+
|
| 70 |
+
### ๐ Original API (Local)
|
| 71 |
+
|
| 72 |
+
```python
|
| 73 |
+
import torch
|
| 74 |
+
from namer import load_namer_model, predict_number_name
|
| 75 |
+
|
| 76 |
+
# Load model
|
| 77 |
+
model = load_namer_model("namer_model.pt")
|
| 78 |
+
|
| 79 |
+
# Convert number to name
|
| 80 |
+
name = predict_number_name(model, 42)
|
| 81 |
+
print(f"42 -> '{name}'")
|
| 82 |
+
```
|
| 83 |
+
|
| 84 |
+
### ๐ป Interactive Mode
|
| 85 |
+
|
| 86 |
+
```bash
|
| 87 |
+
python -m namer infer
|
| 88 |
+
```
|
| 89 |
+
|
| 90 |
+
Then enter numbers to convert interactively.
|
| 91 |
+
|
| 92 |
+
## Installation
|
| 93 |
+
|
| 94 |
+
Choose either repository โ both have identical code:
|
| 95 |
+
|
| 96 |
+
**Option 1: Clone from HuggingFace**
|
| 97 |
+
```bash
|
| 98 |
+
git clone https://huggingface.co/edwinhere/namer
|
| 99 |
+
cd namer
|
| 100 |
+
pip install -e .
|
| 101 |
+
```
|
| 102 |
+
|
| 103 |
+
**Option 2: Clone from GitHub**
|
| 104 |
+
```bash
|
| 105 |
+
git clone https://github.com/edwinhere/namer.git
|
| 106 |
+
cd namer
|
| 107 |
+
pip install -e .
|
| 108 |
+
```
|
| 109 |
+
|
| 110 |
+
**Option 3: Direct pip install (from GitHub)**
|
| 111 |
+
```bash
|
| 112 |
+
pip install git+https://github.com/edwinhere/namer.git
|
| 113 |
+
```
|
| 114 |
+
|
| 115 |
+
## Model Architecture
|
| 116 |
+
|
| 117 |
+
- **Type**: Sequence-to-sequence transformer
|
| 118 |
+
- **Input**: Digits of the integer (as token indices)
|
| 119 |
+
- **Output**: English words representing the number
|
| 120 |
+
- **Vocabulary**: English number words (zero-nineteen, twenty-ninety, hundred, thousand, million, billion, etc.)
|
| 121 |
+
- **Max Output Length**: 20 tokens
|
| 122 |
+
|
| 123 |
+
## Files
|
| 124 |
+
|
| 125 |
+
| File | Description |
|
| 126 |
+
|------|-------------|
|
| 127 |
+
| `pytorch_model.bin` | HuggingFace model weights |
|
| 128 |
+
| `config.json` | Model configuration |
|
| 129 |
+
| `generation_config.json` | Generation parameters |
|
| 130 |
+
| `modeling_namer.py` | HF-compatible model implementation |
|
| 131 |
+
| `namer_model.pt` | Original PyTorch checkpoint |
|
| 132 |
+
| `namer/` | Source code package |
|
| 133 |
+
|
| 134 |
+
## Training
|
| 135 |
+
|
| 136 |
+
To train from scratch:
|
| 137 |
+
|
| 138 |
+
```bash
|
| 139 |
+
python -m namer train
|
| 140 |
+
```
|
| 141 |
+
|
| 142 |
+
## Citation
|
| 143 |
+
|
| 144 |
+
If you use this model, please cite:
|
| 145 |
+
|
| 146 |
+
```bibtex
|
| 147 |
+
@software{namer,
|
| 148 |
+
author = {Edwin Jose Palathinkal},
|
| 149 |
+
title = {Namer: Integer to English Name Converter},
|
| 150 |
+
url = {https://huggingface.co/edwinhere/namer}
|
| 151 |
+
}
|
| 152 |
+
```
|
| 153 |
+
|
| 154 |
+
## Links
|
| 155 |
+
|
| 156 |
+
| Platform | URL | Purpose |
|
| 157 |
+
|----------|-----|---------|
|
| 158 |
+
| ๐ค HuggingFace | [huggingface.co/edwinhere/namer](https://huggingface.co/edwinhere/namer) | Model card, inference API, downloads |
|
| 159 |
+
| ๐ GitHub | [github.com/edwinhere/namer](https://github.com/edwinhere/namer) | Source code, issues, development |
|
README.md.tmp
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
language: en
|
| 3 |
+
license: mit
|
| 4 |
+
library_name: pytorch
|
| 5 |
+
tags:
|
| 6 |
+
- text-generation
|
| 7 |
+
- number-to-text
|
| 8 |
+
- pytorch
|
| 9 |
+
- transformer
|
| 10 |
+
- stratified-sampling
|
| 11 |
+
pipeline_tag: text-generation
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# Namer
|
| 15 |
+
|
| 16 |
+
A PyTorch transformer model that converts **integers to their English names** โ now supporting numbers up to **999,999,999,999** (nearly one trillion)!
|
| 17 |
+
|
| 18 |
+
## Quick Start
|
| 19 |
+
|
| 20 |
+
```python
|
| 21 |
+
from transformers import AutoModel
|
| 22 |
+
from namer import NamerPipeline
|
| 23 |
+
|
| 24 |
+
# Load model
|
| 25 |
+
model = AutoModel.from_pretrained(
|
| 26 |
+
"edwinhere/namer",
|
| 27 |
+
trust_remote_code=True
|
| 28 |
+
)
|
| 29 |
+
|
| 30 |
+
# Create pipeline
|
| 31 |
+
pipe = NamerPipeline(model)
|
| 32 |
+
|
| 33 |
+
# Generate number names
|
| 34 |
+
print(pipe.generate(42)) # "forty two"
|
| 35 |
+
print(pipe.generate(1234567890)) # "one billion two hundred thirty four million..."
|
| 36 |
+
print(pipe.generate(999999999999)) # "nine hundred ninety nine billion..."
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
## Model Description
|
| 40 |
+
|
| 41 |
+
Namer is a sequence-to-sequence transformer trained to read digits of a number and generate the corresponding English textual representation.
|
| 42 |
+
|
| 43 |
+
### Key Features
|
| 44 |
+
|
| 45 |
+
- ๐ฏ **Stratified Training**: Balanced sampling across number scales ensures accurate performance on both small and large numbers
|
| 46 |
+
- ๐ **Large Range**: Handles numbers from 0 to ~1 trillion (12 digits)
|
| 47 |
+
- ๐ **Fast Inference**: Single forward pass, no autoregressive generation needed
|
| 48 |
+
- ๐ **High Accuracy**: >99.9% validation accuracy
|
| 49 |
+
|
| 50 |
+
### Example Conversions
|
| 51 |
+
|
| 52 |
+
| Integer | English Name |
|
| 53 |
+
|---------|-------------|
|
| 54 |
+
| 0 | zero |
|
| 55 |
+
| 42 | forty two |
|
| 56 |
+
| 123 | one hundred twenty three |
|
| 57 |
+
| 1000 | one thousand |
|
| 58 |
+
| 999999 | nine hundred ninety nine thousand nine hundred ninety nine |
|
| 59 |
+
| 1234567890 | one billion two hundred thirty four million five hundred sixty seven thousand eight hundred ninety |
|
| 60 |
+
| 999999999999 | nine hundred ninety nine billion nine hundred ninety nine million nine hundred ninety nine thousand nine hundred ninety nine |
|
| 61 |
+
|
| 62 |
+
## Architecture
|
| 63 |
+
|
| 64 |
+
- **Type**: Transformer encoder with learned queries and cross-attention
|
| 65 |
+
- **Parameters**: ~869K
|
| 66 |
+
- **Vocabulary**: 41 tokens (number words + EOS)
|
| 67 |
+
- **Max Output Length**: 25 tokens
|
| 68 |
+
- **Input**: Digit sequences (0-9 + padding)
|
| 69 |
+
|
| 70 |
+
## Training Details
|
| 71 |
+
|
| 72 |
+
- **Dataset**: Infinite stratified sampling across 5 scales (units, thousands, millions, billions, trillions)
|
| 73 |
+
- **Optimizer**: Adam (lr=0.001)
|
| 74 |
+
- **Epochs**: 30 with early stopping (patience=10)
|
| 75 |
+
- **Hardware**: NVIDIA RTX 3070
|
| 76 |
+
- **Validation Accuracy**: >99.9%
|
| 77 |
+
|
| 78 |
+
### Why Stratified Sampling?
|
| 79 |
+
|
| 80 |
+
With uniform random sampling from 0-1T, 99.9% of samples would be >1M, causing the model to fail on small numbers. Stratified sampling gives each magnitude equal representation (20% each), ensuring robust performance across the entire range.
|
| 81 |
+
|
| 82 |
+
## Version History
|
| 83 |
+
|
| 84 |
+
**v2.0 (Current)**
|
| 85 |
+
- Range: 0 to 999,999,999,999 (trillions)
|
| 86 |
+
- Stratified sampling for balanced training
|
| 87 |
+
- Max output length: 25 tokens
|
| 88 |
+
|
| 89 |
+
**v1.0**
|
| 90 |
+
- Range: 0 to 999,999 (millions)
|
| 91 |
+
- Uniform random sampling
|
| 92 |
+
- Max output length: 20 tokens
|
| 93 |
+
|
| 94 |
+
## Limitations
|
| 95 |
+
|
| 96 |
+
- Maximum: 999,999,999,999 (12 digits)
|
| 97 |
+
- No negative numbers (uses absolute value)
|
| 98 |
+
- No decimal/fractional numbers
|
| 99 |
+
|
| 100 |
+
## Citation
|
| 101 |
+
|
| 102 |
+
```bibtex
|
| 103 |
+
@software{namer,
|
| 104 |
+
author = {Edwin Jose Palathinkal},
|
| 105 |
+
title = {Namer: Integer to English Name Converter},
|
| 106 |
+
url = {https://huggingface.co/edwinhere/namer},
|
| 107 |
+
year = {2025}
|
| 108 |
+
}
|
| 109 |
+
```
|
| 110 |
+
|
| 111 |
+
## Links
|
| 112 |
+
|
| 113 |
+
- GitHub: https://github.com/edwinhere/namer
|
| 114 |
+
- HuggingFace: https://huggingface.co/edwinhere/namer
|