sum

text summarization utility

    _____                       _
   / ____|                     (_)
  | (___   _   _  _ __ ___      _  ___
   \___ \ | | | || '_ ` _ \    | |/ __|
   ____) || |_| || | | | | | _ | |\__ \
  |_____/  \__,_||_| |_| |_|(_)| ||___/
                              _/ |
                             |__/

Sum.js

Indicator
continuous integration
dependency management
change log CHANGELOG Releases

A simple function for summarizing text e.g. for automatically determining the sentences that are most relevant to the context of the corpus. This library depends on the underscore, underscore.string and porter-stemmer.

Install in node.js

sudo npm install -g sum

Install in browser

<script src="/lib/underscore.js"></script>
<script src="/lib/underscore.string.js"></script>
<script src="/lib/porter-stemmer.js"></script>
<script src="/sum.js"></script>

Quick Start

var sum = require( 'sum' );
var bigString = "....";
var abstract = sum({ 'corpus': bigString });
// `abstract` is an object w/ format `{"summary":String, "sentences":Array<String>}`
// where summary is the concatenation of the array of sentences.

Further Options

var sum = require( 'sum' );
var anotherBigString = "...";
var abstract = sum({
    /**
     * `corpus`: String - is the string you want to summarize
     */
    'corpus': anotherBigString,

    /**
     * `nSentences`: Number - controls the number of sentences from the original text included in the abstact
     */
    'nSentences': 3,

    /**
     * `nWords`: Number - controls the length in words of the nGram output. Output might be larger as some words are ignored in the algorithm but present in the abstract, for ex. prepositions. When `nWords` is set, `nSentences` is ignored
     */
    'nWords': 5,

    /**
     * `exclude`: Array[String] - sum.js allows you to exclude from the final abstract, sentences or nGrams that contain any of the words in the `exclude` param
     */
    'exclude': ['polar', 'bear'],

    /**
     * `emphasise`: Array[String] - forces sum.js to include in the summary the sentences or nGrams that contain any the words specified by `emphasise` param.
     */
    'emphasise': ['magic']
});

//`abstract` is an object with format {'sentences':Array<String>, 'summary':String} where summary is just the concatenation of the sentences, for convenience.
console.log("The short version of corpus is ", abstract.summary);

Running tests

Run /tests/browser/specrunner.html in your favourite browser.

To run node tests, run npm run test.

Goals

This library is intended to be fully embeddable. It's purpose is to be used primarly on the client-side. It should be self-contained so no API calls to external services. It should be as light as possible, both in terms of code size and dependencies and above all it must be fast. Because of these constraints, the algorithm used is purely statistical, using TF IDF to calculate abstracts. Other methods of text summarization proposed by researchers in NLP and ML produce better results but are not (to my best of knowledge) practical in the browser context as many of them require intense computation to produce their output.

TODO

  1. add tests to verify the correctness of the actual output
  2. currenty the output does not preserve the ending chars of the original sentences
  3. make the lib more plugable, e.g allow plugin of custom algorithms, string cleaning rutines, etc.
  4. better control for the length of the summary, by words, by letters
  5. add more algorithms to calculate abstracts
  6. Make the library's inner utility functions available as some of them might be usefull

Licence

(The MIT License)

Copyright (c) Alex Topliceanu alexandru.topliceanu@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

HomePage

https://github.com/topliceanu/sum

Repository

https://github.com/topliceanu/sum


上一篇:apostrophe-site
下一篇:porter-stemmer

相关推荐

  • 我用JS刷LeetCode | Day 1 | Two Sum

    说明:现阶段的解题暂未考虑复杂度问题 原文链接:www.brandhuang.com/article/158… Question: Given an array of integers, retu...

    7 个月前
  • 前端干货之随机图库 Lorem Picsum

    你还在为找不到图片而烦恼吗? 你可以尝试着刷新页面!或者在这里体验 今天给大家推荐一个免费的图片库 Lorem Picsum,简单好用 获取指定大小的随机图片 /public/uploa...

    3 个月前
  • 前端工程师的 LeetCode 之旅 -- 双指针技巧 Medium 篇(K-Sum)

    一、前言   本篇主要介绍双指针技巧的第二类题型:对数组进行预处理之后,再采用双指针遍历。   在 Medium 难度的题目中,此类问题可以归纳为 K-Sum 问题: 两数之和:【881. 救生艇】...

    1 年前
  • yaml2resume

    No name given yet yaml2resume No name given yet Install Install it with npm install yaml2resumeUsa...

    1 年前
  • writable-consumable-stream

    An async stream which can be iterated over using a for-await-of loop. writable-consumable-stream An ...

    1 年前
  • videojs-resume

    Resume playback in VideoJS VideoJS Resume A VideoJS plugin to resume playback of a video at the poin...

    3 个月前
  • url-summarizer

    Scrapes a remote page and creates a summary with statistics. URL Summarizer Scrapes a remote page a...

    10 个月前
  • two-sum两数之和 javascript解答

    LeetCode 第 1 号问题:两数之和题目地址https://leetcode-cn.com/probl...题目描述 给定一个整数数组 nums 和一个目标值 target,请你在该数组中找出...

    1 个月前
  • two-sum

    Computes a non-overlapping sequence representing the sum of two floating point numbers. two-sum Comp...

    2 年前
  • textlint-rule-no-mix-dearu-desumasu

    textlint rule that no mixed である and ですます. textlint-rule-no-mix-dearu-desumasu 敬体(ですます調)と常体(である調)の混...

    1 个月前

官方社区

扫码加入 JavaScript 社区