add usage
Browse files
README.md
CHANGED
@@ -204,6 +204,7 @@ parameters:
|
|
204 |
|
205 |
An experiment investigating transfer learning capabilities by fine-tuning models on different datasets starting from the `booksum` checkpoint.
|
206 |
|
|
|
207 |
## Model Details
|
208 |
|
209 |
This model is a fine-tuned version of [pszemraj/long-t5-tglobal-base-16384-book-summary](https://huggingface.co/pszemraj/long-t5-tglobal-base-16384-book-summary) on the `pszemraj/scientific_lay_summarisation-elife-norm` dataset for two epochs.
|
@@ -216,6 +217,27 @@ It achieves the following results on the evaluation set:
|
|
216 |
- Rougelsum: 30.6965
|
217 |
- Gen Len: 294.0249
|
218 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
219 |
## Intended uses & limitations
|
220 |
|
221 |
- This is an initial experiment
|
|
|
204 |
|
205 |
An experiment investigating transfer learning capabilities by fine-tuning models on different datasets starting from the `booksum` checkpoint.
|
206 |
|
207 |
+
|
208 |
## Model Details
|
209 |
|
210 |
This model is a fine-tuned version of [pszemraj/long-t5-tglobal-base-16384-book-summary](https://huggingface.co/pszemraj/long-t5-tglobal-base-16384-book-summary) on the `pszemraj/scientific_lay_summarisation-elife-norm` dataset for two epochs.
|
|
|
217 |
- Rougelsum: 30.6965
|
218 |
- Gen Len: 294.0249
|
219 |
|
220 |
+
|
221 |
+
## Usage
|
222 |
+
|
223 |
+
It's recommended to usage this model with [beam search decoding](https://huggingface.co/docs/transformers/generation_strategies#beamsearch-decoding). If interested, you can also use the `textsum` util repo to have most of this abstracted out for you:
|
224 |
+
|
225 |
+
|
226 |
+
```bash
|
227 |
+
pip install -U textsum
|
228 |
+
```
|
229 |
+
|
230 |
+
```python
|
231 |
+
from textsum.summarize import Summarizer
|
232 |
+
|
233 |
+
model_name = "pszemraj/long-t5-tglobal-base-16384-booksci-summary-v1"
|
234 |
+
summarizer = Summarizer(model_name) # GPU auto-detected
|
235 |
+
text = "put the text you don't want to read here"
|
236 |
+
summary = summarizer.summarize_string(text)
|
237 |
+
print(summary)
|
238 |
+
```
|
239 |
+
|
240 |
+
|
241 |
## Intended uses & limitations
|
242 |
|
243 |
- This is an initial experiment
|