An open API service indexing awesome lists of open source software.

https://github.com/cadmiumcr/summarizer

A collection of summarizer algorithms
https://github.com/cadmiumcr/summarizer

crystal crystal-lang crystal-language extractive-summarization kl-divergence luhn nlp sumbasic summarization summarizer

Last synced: 7 months ago
JSON representation

A collection of summarizer algorithms

Awesome Lists containing this project

README

          

# summarizer

![](https://github.com/cadmiumcr/summarizer/workflows/summarizer/badge.svg)

Inspired from [sumy](https://github.com/miso-belica/sumy), summarizer lets you summarize any input text through extraction based algorithms.

As of now, the following algorithms are implemented :

- Luhn
- KL divergence based summarizer (WIP)
- SumBasic
- TextRank

More are being worked on.

## Installation

1. Add the dependency to your `shard.yml`:

```yaml
dependencies:
cadmium_summarizer:
github: cadmiumcr/summarizer
```

2. Run `shards install`

## Usage

```crystal
require "cadmium_summarizer"

SumBasic.new.summarize(long_text)
```

## Contributing

1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [Rémy Marronnier](https://github.com/rmarronnier) - creator and maintainer