|
| 1 | +--- |
| 2 | +title: Vue Text Summarization |
| 3 | +emoji: 📝 |
| 4 | +colorFrom: green |
| 5 | +colorTo: blue |
| 6 | +sdk: static |
| 7 | +pinned: false |
| 8 | +license: apache-2.0 |
| 9 | +models: |
| 10 | + - Xenova/distilbart-cnn-6-6 |
| 11 | +short_description: Text summarization using Transformers.js in Vue.js |
| 12 | +--- |
| 13 | + |
1 | 14 | # Vue Text Summarization Application |
2 | 15 |
|
3 | 16 | 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 | 17 |
|
5 | | -## How it works |
| 18 | +## Getting Started |
6 | 19 |
|
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. |
| 20 | +Follow the steps below to set up and run the application. |
8 | 21 |
|
9 | | -## Features |
| 22 | +### 1. Clone the Repository |
10 | 23 |
|
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 |
| 24 | +Clone the examples repository from GitHub: |
15 | 25 |
|
16 | | -## Recommended IDE Setup |
| 26 | +```sh |
| 27 | +git clone https://github.com/huggingface/transformers.js-examples.git |
| 28 | +``` |
17 | 29 |
|
18 | | -[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). |
| 30 | +### 2. Navigate to the Project Directory |
19 | 31 |
|
20 | | -## Recommended Browser Setup |
| 32 | +Change your working directory to the `vue` folder: |
21 | 33 |
|
22 | | -- Chromium-based browsers (Chrome, Edge, Brave, etc.): |
23 | | - - [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd) |
24 | | - - [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters) |
25 | | -- Firefox: |
26 | | - - [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/) |
27 | | - - [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/) |
| 34 | +```sh |
| 35 | +cd transformers.js-examples/vue |
| 36 | +``` |
| 37 | + |
| 38 | +### 3. Install Dependencies |
28 | 39 |
|
29 | | -## Project Setup |
| 40 | +Install the necessary dependencies using npm: |
30 | 41 |
|
31 | 42 | ```sh |
32 | 43 | npm install |
33 | 44 | ``` |
34 | 45 |
|
35 | | -### Compile and Hot-Reload for Development |
| 46 | +### 4. Run the Development Server |
| 47 | + |
| 48 | +Start the development server: |
36 | 49 |
|
37 | 50 | ```sh |
38 | 51 | npm run dev |
39 | 52 | ``` |
40 | 53 |
|
41 | | -### Compile and Minify for Production |
| 54 | +The application should now be running locally. Open your browser and go to `http://localhost:5173` to see it in action. |
42 | 55 |
|
43 | | -```sh |
44 | | -npm run build |
45 | | -``` |
| 56 | +## How it works |
| 57 | + |
| 58 | +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. |
46 | 59 |
|
47 | | -### Lint with [ESLint](https://eslint.org/) |
| 60 | +## Features |
48 | 61 |
|
49 | | -```sh |
50 | | -npm run lint |
51 | | -``` |
| 62 | +- **Text Summarization**: Uses the Xenova/distilbart-cnn-6-6 model for high-quality text summarization |
| 63 | +- **Real-time Processing**: Streaming output shows summary generation in real-time |
| 64 | +- **Progress Tracking**: Visual progress bars during model loading |
| 65 | +- **Responsive UI**: Clean, modern interface built with Vue 3 |
| 66 | + |
| 67 | +## Recommended IDE Setup |
| 68 | + |
| 69 | +[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar). |
52 | 70 |
|
53 | 71 | ## Model Information |
54 | 72 |
|
|
0 commit comments