https://github.com/raulil/smmry-fi

Summarizes articles and text written in Finnish
https://github.com/raulil/smmry-fi

finnish summarization text-processing

Last synced: about 5 hours ago
JSON representation

Summarizes articles and text written in Finnish

• Host: GitHub
• URL: https://github.com/raulil/smmry-fi
• Owner: RauliL
• Created: 2017-01-12T22:53:47.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-22T10:29:45.000Z (10 months ago)
• Last Synced: 2024-04-25T21:22:22.125Z (7 months ago)
• Topics: finnish, summarization, text-processing
• Language: TypeScript
• Size: 98.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# smmry-fi

[![github][github-image]][github-url]

[![coveralls][coveralls-image]][coveralls-url]

[![npm][npm-image]][npm-url]

[github-image]: https://github.com/RauliL/smmry-fi/actions/workflows/test.yml/badge.svg

[github-url]: https://github.com/RauliL/smmry-fi/actions/workflows/test.yml

[coveralls-image]: https://coveralls.io/repos/github/RauliL/smmry-fi/badge.svg

[coveralls-url]: https://coveralls.io/github/RauliL/smmry-fi

[npm-image]: https://img.shields.io/npm/v/smmry-fi

[npm-url]: https://www.npmjs.com/package/smmry-fi

Creates TL;DR type summaries from text written in Finnish.

[Online demo](https://rauli.dev/smmry-fi/)

## How it works

1. The input text is split into sentences.

2. From each sentence common stopwords are removed and the remaining words are

   being stemmed into their most basic form and counted for "score".

3. Sentences with highest score count are returned from the original text.

## Installation

```shell

$ npm install smmry-fi

```

## Usage

```TypeScript

import { createSummary } from "smmry-fi";

const summary = createSummary(longTextToCreateSummaryFrom);

```