Skip to content

Commit f621706

Browse files
committed
update readme for vue application
1 parent c4c64e0 commit f621706

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

vue/README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
1-
# vue
1+
# Vue Text Summarization Application
22

3-
This template should help get you started developing with Vue 3 in Vite.
3+
This folder contains the source code for a web application that summarizes text using Transformers.js! The app uses the DistilBART-CNN model to generate concise summaries of input text.
4+
5+
## How it works
6+
7+
The user enters text in the input textarea and clicks "Summarize". The application processes the text using the DistilBART-CNN model and displays a summarized version in the output area. The model runs entirely in the browser using WebAssembly and ONNX Runtime.
8+
9+
## Features
10+
11+
- **Text Summarization**: Uses the Xenova/distilbart-cnn-6-6 model for high-quality text summarization
12+
- **Real-time Processing**: Streaming output shows summary generation in real-time
13+
- **Progress Tracking**: Visual progress bars during model loading
14+
- **Responsive UI**: Clean, modern interface built with Vue 3
415

516
## Recommended IDE Setup
617

@@ -9,16 +20,12 @@ This template should help get you started developing with Vue 3 in Vite.
920
## Recommended Browser Setup
1021

1122
- Chromium-based browsers (Chrome, Edge, Brave, etc.):
12-
- [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
23+
- [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
1324
- [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
1425
- Firefox:
1526
- [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
1627
- [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)
1728

18-
## Customize configuration
19-
20-
See [Vite Configuration Reference](https://vite.dev/config/).
21-
2229
## Project Setup
2330

2431
```sh
@@ -42,3 +49,10 @@ npm run build
4249
```sh
4350
npm run lint
4451
```
52+
53+
## Model Information
54+
55+
- **Model**: [Xenova/distilbart-cnn-6-6](https://huggingface.co/Xenova/distilbart-cnn-6-6)
56+
- **Task**: Summarization
57+
- **Framework**: Transformers.js
58+
- **Backend**: ONNX Runtime Web

0 commit comments

Comments
 (0)