lexrankmmr

README

lexrankmmr

Algorithm

LexRank: Graph-based Lexical Centrality as Salience in Text Summarization

The Use of MMR, Diversity-Based Reranking for Reordering Documents and Producing Summaries

Dependency

• github.com/dcadenas/pagerank
• github.com/gaspiman/cosine_similarity
• github.com/ikawaha/kagome

install

go get github.com/ramenjuniti/lexrankmmr

Usage

package main

import github.com/ramenjuniti/lexrankmmr

func main() {
    text := "Please input the document you want to summarize here."
    summary, err := lexrankmmr.New(
        lexrankmmr.MaxLines(maxLines),            // option (default 0)
        lexrankmmr.MaxCharacters(maxCharacters),  // option (default 0)
        lexrankmmr.Threshold(threshold),          // option (default 0.1)
        lexrankmmr.Tolerance(tolerance),          // option (default 0.0001)
        lexrankmmr.Damping(damping),              // option (default 0.85)
        lexrankmmr.Lambda(lambda),                // option (default 1.0)
    )
    err = summary.Summarize(text)
    if err != nil {
        log.Fatal(err)
    }
}

License

This software is released under the MIT License, see LICENSE.

Documentation

Index

• type Option
  • func Damping(damping float64) Option
  • func Lambda(lambda float64) Option
  • func MaxCharacters(maxCharacters int) Option
  • func MaxLines(maxLines int) Option
  • func Threshold(threshold float64) Option
  • func Tolerance(tolerance float64) Option
• type SummaryData
  • func New(options ...Option) (*SummaryData, error)
  • func (s *SummaryData) Summarize(text string) error

Types

type Option

type Option func(*SummaryData) error

Option for Functional Option Pattern

func Damping

func Damping(damping float64) Option

Damping set SummaryData.damping

func Lambda

func Lambda(lambda float64) Option

Lambda set SummaryData.lambda

func MaxCharacters

func MaxCharacters(maxCharacters int) Option

MaxCharacters set SummaryData.maxCharacters

func MaxLines

func MaxLines(maxLines int) Option

MaxLines set SummaryData.maxLines

func Threshold

func Threshold(threshold float64) Option

Threshold set SummaryData.threshold

func Tolerance

func Tolerance(tolerance float64) Option

Tolerance set SummaryData.tolerance

type SummaryData

type SummaryData struct {
	LineLimitedSummary      []lexRankScore
	CharacterLimitedSummary []lexRankScore
	// contains filtered or unexported fields
}

SummaryData contains data for summary

func New

func New(options ...Option) (*SummaryData, error)

New return SummaryData

func (*SummaryData) Summarize

func (s *SummaryData) Summarize(text string) error

Summarize generate summary