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
- Host: GitHub
- URL: https://github.com/cadmiumcr/summarizer
- Owner: cadmiumcr
- License: mit
- Created: 2019-08-26T07:04:25.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-26T13:20:08.000Z (over 5 years ago)
- Last Synced: 2025-01-14T01:15:22.239Z (9 months ago)
- Topics: crystal, crystal-lang, crystal-language, extractive-summarization, kl-divergence, luhn, nlp, sumbasic, summarization, summarizer
- Language: Crystal
- Size: 81.1 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# summarizer

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
- TextRankMore 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