Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.02 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.02 KB
Raw

summarizer

Inspired from 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:

    dependencies:
  cadmium_summarizer:
    github: cadmiumcr/summarizer

  2. Run shards install

Usage

require "cadmium_summarizer"

SumBasic.new.summarize(long_text)

Contributing

  1. Fork it (https://github.com/cadmiumcr/summarizer/fork)
  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