Edwin Jose Palathinkal commited on
Commit
72c9685
Β·
1 Parent(s): 7b5123e

Add cross-links to HuggingFace and GitHub repos; update install instructions for both sources

Browse files
Files changed (1) hide show
  1. README.md +24 -1
README.md CHANGED
@@ -11,8 +11,13 @@ tags:
11
 
12
  # Namer
13
 
 
 
 
14
  A PyTorch transformer model that converts **integers to their English names** (e.g., `42` β†’ "forty two", `123` β†’ "one hundred twenty three").
15
 
 
 
16
  ## Model Description
17
 
18
  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.
@@ -87,12 +92,27 @@ python -m namer train
87
 
88
  ## Installation
89
 
 
 
 
90
  ```bash
91
  git clone https://huggingface.co/edwinhere/namer
92
  cd namer
93
  pip install -e .
94
  ```
95
 
 
 
 
 
 
 
 
 
 
 
 
 
96
  ## Citation
97
 
98
  If you use this model, please cite:
@@ -107,4 +127,7 @@ If you use this model, please cite:
107
 
108
  ## Links
109
 
110
- - [GitHub Repository](https://github.com/edwinhere/namer)
 
 
 
 
11
 
12
  # Namer
13
 
14
+ [![HuggingFace](https://img.shields.io/badge/πŸ€—_HuggingFace-Model_Card-yellow)](https://huggingface.co/edwinhere/namer)
15
+ [![GitHub](https://img.shields.io/badge/πŸ™_GitHub-Source_Code-blue)](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.
 
92
 
93
  ## Installation
94
 
95
+ Choose either repository β€” both have identical code:
96
+
97
+ **Option 1: Clone from HuggingFace**
98
  ```bash
99
  git clone https://huggingface.co/edwinhere/namer
100
  cd namer
101
  pip install -e .
102
  ```
103
 
104
+ **Option 2: Clone from GitHub**
105
+ ```bash
106
+ git clone https://github.com/edwinhere/namer.git
107
+ cd namer
108
+ pip install -e .
109
+ ```
110
+
111
+ **Option 3: Direct pip install (from GitHub)**
112
+ ```bash
113
+ pip install git+https://github.com/edwinhere/namer.git
114
+ ```
115
+
116
  ## Citation
117
 
118
  If you use this model, please cite:
 
127
 
128
  ## Links
129
 
130
+ | Platform | URL | Purpose |
131
+ |----------|-----|---------|
132
+ | πŸ€— HuggingFace | [huggingface.co/edwinhere/namer](https://huggingface.co/edwinhere/namer) | Model card, inference API, downloads |
133
+ | πŸ™ GitHub | [github.com/edwinhere/namer](https://github.com/edwinhere/namer) | Source code, issues, development |