buley commited on
Commit
f953d74
·
verified ·
1 Parent(s): 2aef840

Update model card with proper metadata and documentation

Browse files
Files changed (1) hide show
  1. README.md +40 -54
README.md CHANGED
@@ -1,90 +1,76 @@
1
  ---
2
- language: en
 
3
  license: mit
4
- library_name: transformers
5
- pipeline_tag: summarization
6
  tags:
7
  - onnx
 
 
 
8
  - quantized
9
  - int8
10
- - transformers.js
11
- - summarization
12
  - bart
13
- - browser-inference
 
 
 
14
  datasets:
15
  - cnn_dailymail
16
- base_model: facebook/bart-large-cnn
17
  ---
18
 
19
- # BART-Large CNN Summarization (ONNX, Quantized int8)
20
 
21
- Quantized ONNX version of [facebook/bart-large-cnn](https://huggingface.co/facebook/bart-large-cnn) for efficient in-browser text summarization with [transformers.js](https://huggingface.co/docs/transformers.js).
22
 
23
- ## Overview
24
 
25
- | | |
26
- |---|---|
27
- | **Task** | Abstractive text summarization |
28
- | **Base Model** | BART-large (406M params) |
29
- | **Format** | ONNX, dynamic quantization (int8) |
30
- | **Size** | ~493 MB (vs ~1.6 GB fp32) |
31
- | **Dataset** | [CNN/DailyMail](https://huggingface.co/datasets/cnn_dailymail) |
32
- | **Original Downloads** | 2.2M+ |
33
 
34
- ## Usage with transformers.js
35
 
36
  ```javascript
37
- import { pipeline } from '@xenova/transformers';
38
 
39
  const summarizer = await pipeline(
40
  'summarization',
41
  'affectively-ai/bart-large-cnn-onnx',
42
- { quantized: true }
43
  );
44
 
45
  const result = await summarizer(
46
- 'The tower is 324 metres (1,063 ft) tall, about the same height as an ' +
47
- '81-storey building, and the tallest structure in Paris. Its base is ' +
48
- 'square, measuring 125 metres on each side. It was the first structure ' +
49
- 'to reach a height of 300 metres.',
50
- { max_length: 60, min_length: 20 }
51
  );
52
- // [{ summary_text: 'The tower is 324 metres tall, about the same height as an 81-storey building. It was the first structure to reach a height of 300 metres.' }]
53
  ```
54
 
55
- ## Why This Model?
56
 
57
- BART-Large-CNN is the gold standard for English summarization:
58
- - **2.2M+ downloads** — the most popular summarization model on HuggingFace
59
- - Generates **fluent, abstractive summaries** (not just extractive)
60
- - Fine-tuned on **300K news articles** with human-written summaries
61
- - At **493 MB** quantized, it's practical for in-browser use
 
 
62
 
63
  ## Use Cases
64
 
65
- - Summarize journal entries in emotion tracking apps
66
- - Condense long therapy session notes
67
- - Create digest versions of articles or feedback
68
- - Summarize conversation threads
69
-
70
- ## Conversion Details
71
-
72
- - **Exported** from PyTorch using [Optimum](https://huggingface.co/docs/optimum)
73
- - **Quantized** to int8 using `ORTQuantizer` with `avx512_vnni` config (encoder + decoder quantized separately)
74
- - **Converted by** [AFFECTIVELY](https://affectively.ai) via Cloud Build pipeline
75
-
76
- ## Links
77
 
78
- - **Website**: [aeonflux.dev](https://aeonflux.dev)
79
- - **Documentation**: [docs.aeonflux.dev](https://docs.aeonflux.dev)
80
- - **Storybook**: [storybook.aeonflux.dev](https://storybook.aeonflux.dev)
81
- - **GitHub**: [github.com/affectively-ai](https://github.com/affectively-ai)
82
- - **All Models**: [huggingface.co/affectively-ai](https://huggingface.co/affectively-ai)
83
 
84
- ## About AFFECTIVELY
85
 
86
- [AFFECTIVELY](https://affectively.ai) is an emotion tracking and analysis platform. This model enables in-browser summarization of emotional journals and conversations.
87
 
88
- ## License
89
 
90
- MIT (same as base model)
 
1
  ---
2
+ language:
3
+ - en
4
  license: mit
5
+ library_name: onnx
 
6
  tags:
7
  - onnx
8
+ - summarization
9
+ - transformers.js
10
+ - in-browser
11
  - quantized
12
  - int8
 
 
13
  - bart
14
+ - affectively
15
+ - edgework
16
+ base_model: facebook/bart-large-cnn
17
+ pipeline_tag: summarization
18
  datasets:
19
  - cnn_dailymail
 
20
  ---
21
 
22
+ # BART Large CNN (ONNX, int8 Quantized)
23
 
24
+ > **Production-ready** ONNX conversion of [facebook/bart-large-cnn](https://huggingface.co/facebook/bart-large-cnn) for in-browser text summarization zero server cost, zero latency, complete privacy.
25
 
26
+ ## Highlights
27
 
28
+ - **Abstractive summarization** — generates concise summaries, not just extractive snippets
29
+ - **~493 MB** quantized — BART-large architecture fine-tuned on CNN/DailyMail
30
+ - **transformers.js compatible** drop-in `pipeline('summarization')`
31
+ - **406M parameters** high-quality summaries from long-form text
 
 
 
 
32
 
33
+ ## Quick Start
34
 
35
  ```javascript
36
+ import { pipeline } from '@huggingface/transformers';
37
 
38
  const summarizer = await pipeline(
39
  'summarization',
40
  'affectively-ai/bart-large-cnn-onnx',
41
+ { dtype: 'q8' }
42
  );
43
 
44
  const result = await summarizer(
45
+ 'Today was an incredibly challenging day at work. I had back-to-back meetings...',
46
+ { max_length: 50, min_length: 20 }
 
 
 
47
  );
48
+ // [{ summary_text: 'The author had a challenging day with back-to-back meetings...' }]
49
  ```
50
 
51
+ ## Conversion Details
52
 
53
+ | Property | Value |
54
+ |----------|-------|
55
+ | Base model | [facebook/bart-large-cnn](https://huggingface.co/facebook/bart-large-cnn) |
56
+ | Training data | CNN/DailyMail (300k news articles) |
57
+ | Export | PyTorch ONNX via [Optimum](https://huggingface.co/docs/optimum) |
58
+ | Quantization | int8 dynamic (`ORTQuantizer`, avx512_vnni) |
59
+ | Quantized size | ~493 MB |
60
 
61
  ## Use Cases
62
 
63
+ This model powers text summarization in [Edgework.ai](https://edgework.ai) bringing fast, cheap, and private inference as close to the user as possible. Best for:
 
 
 
 
 
 
 
 
 
 
 
64
 
65
+ - Summarizing journal entries for daily/weekly emotion reports
66
+ - Condensing therapy session notes
67
+ - Creating digests from long conversation threads
68
+ - Generating TL;DR for mental wellness content
 
69
 
70
+ ## About
71
 
72
+ Published by [AFFECTIVELY](https://huggingface.co/affectively-ai) · Managed by [@buley](https://huggingface.co/buley)
73
 
74
+ We convert, quantize, and publish **production-ready ONNX models** for edge and in-browser inference. Every release is tested for correctness and stability before publication.
75
 
76
+ - [All models](https://huggingface.co/affectively-ai) · [GitHub](https://github.com/affectively-ai) · [Edgework.ai](https://edgework.ai)