Skip to content

Commit

Permalink
chore: switch to MIT license
Browse files Browse the repository at this point in the history
  • Loading branch information
sanjayaksaxena committed Nov 8, 2018
1 parent 65b6fa7 commit b4c92d6
Show file tree
Hide file tree
Showing 16 changed files with 825 additions and 1,803 deletions.
13 changes: 0 additions & 13 deletions .jshintrc

This file was deleted.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Like artisans, we too need a toolset and process to create beautiful software. T


### Linting
Well defined linting rules helps us in making code more consistent and avoid bugs. [ESLint](https://eslint.org) and [JSHint](http://jshint.com/) enforces these rules via their configuration files. These files are in the root of each repository.
Well defined linting rules helps us in making code more consistent and avoid bugs. [ESLint](https://eslint.org) enforces these rules via its configuration file. This file is located in the root of each repository.


### Documenting
Expand Down
640 changes: 21 additions & 619 deletions LICENSE

Large diffs are not rendered by default.

13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,14 @@ Accurate & fast sentiment scoring of phrases with #hashtags, emoticons:) & emoji

[<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](http://winkjs.org/)

Analyze sentiment of tweets, product reviews, social media content or any text using **`wink-sentiment`**. It is a part of _[wink](http://winkjs.org/)_ — a growing family of high quality packages for Statistical Analysis, Natural Language Processing and Machine Learning in NodeJS.

It is based on [AFINN](https://arxiv.org/abs/1103.2903) and [Emoji Sentiment Ranking](http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0144296); it's features include:
Analyze sentiment of tweets, product reviews, social media content or any text using **`wink-sentiment`**. It is based on [AFINN](https://arxiv.org/abs/1103.2903) and [Emoji Sentiment Ranking](http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0144296); it's features include:

1. Intelligent negation handling; for example, phrase "good product" will get a positive score whereas "not a good product" gets a negative score.
2. Automatic detection and scoring of two-word phrases in a text; for example, "cool stuff", "well done", and "short sighted".
3. Processes each emoji, emoticon and/or hashtag separately while scoring.
4. Embeds a powerful [tokenizer](https://www.npmjs.com/package/wink-tokenizer) that returns the tokenized phrase.
5. Returns the sentiment score and tokens. Each token contains a set of properties defining its sentiment, if any.
6. Achieves accuracy of 77%, when validated using Amazon Product Review [Sentiment Labelled Sentences Data Set](https://archive.ics.uci.edu/ml/machine-learning-databases/00331/) at
[UCI Machine Learning Repository](https://archive.ics.uci.edu/ml/index.php).
6. Achieves accuracy of 77%, when validated using Amazon Product Review [Sentiment Labelled Sentences Data Set](https://archive.ics.uci.edu/ml/machine-learning-databases/00331/) at [UCI Machine Learning Repository](https://archive.ics.uci.edu/ml/index.php).


### Installation
Expand Down Expand Up @@ -57,9 +54,11 @@ Check out the [wink sentiment API](http://winkjs.org/wink-sentiment/) documentat

If you spot a bug and the same has not yet been reported, raise a new [issue](https://github.com/winkjs/wink-sentiment/issues) or consider fixing it and sending a pull request.

### About wink
[Wink](http://winkjs.org/) is a family of open source packages for **Statistical Analysis**, **Natural Language Processing** and **Machine Learning** in NodeJS. The code is **thoroughly documented** for easy human comprehension and has a **test coverage of ~100%** for reliability to build production grade solutions.

### Copyright & License

**wink-sentiment** is copyright 2017-18 [GRAYPE Systems Private Limited](http://graype.in/).

It is licensed under the under the terms of the GNU Affero General Public License as published by the Free
Software Foundation, version 3 of the License.
It is licensed under the terms of the MIT License.
4 changes: 2 additions & 2 deletions docs/global.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h4 class="name" id="sentiment"><span class="type-signature"></span>sentiment<sp

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="wink-sentiment.js.html">wink-sentiment.js</a>, <a href="wink-sentiment.js.html#line108">line 108</a>
<a href="wink-sentiment.js.html">wink-sentiment.js</a>, <a href="wink-sentiment.js.html#line111">line 111</a>
</li></ul></dd>


Expand Down Expand Up @@ -327,7 +327,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 11 2018 12:36:18 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 08 2018 12:26:31 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
12 changes: 5 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,14 @@ <h2><a href="index.html">Home</a></h2><h2><a href="http://winkjs.org" target="_b
<section class="readme">
<article><h1>wink-sentiment</h1><p>Accurate &amp; fast sentiment scoring of phrases with #hashtags, emoticons:) &amp; emojis🎉</p>
<h3><a href="https://travis-ci.org/winkjs/wink-sentiment"><img src="https://api.travis-ci.org/winkjs/wink-sentiment.svg?branch=master" alt="Build Status"></a> <a href="https://coveralls.io/github/winkjs/wink-sentiment?branch=master"><img src="https://coveralls.io/repos/github/winkjs/wink-sentiment/badge.svg?branch=master" alt="Coverage Status"></a> <a href="https://david-dm.org/winkjs/wink-sentiment"><img src="https://david-dm.org/winkjs/wink-sentiment/status.svg" alt="dependencies Status"></a> <a href="https://david-dm.org/winkjs/wink-sentiment?type=dev"><img src="https://david-dm.org/winkjs/wink-sentiment/dev-status.svg" alt="devDependencies Status"></a> <a href="https://gitter.im/winkjs/Lobby"><img src="https://img.shields.io/gitter/room/nwjs/nw.js.svg" alt="Gitter"></a></h3><p><a href="http://winkjs.org/"><img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" ></a></p>
<p>Analyze sentiment of tweets, product reviews, social media content or any text using <strong><code>wink-sentiment</code></strong>. It is a part of <em><a href="http://winkjs.org/">wink</a></em> — a growing family of high quality packages for Statistical Analysis, Natural Language Processing and Machine Learning in NodeJS.</p>
<p>It is based on <a href="https://arxiv.org/abs/1103.2903">AFINN</a> and <a href="http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0144296">Emoji Sentiment Ranking</a>; it's features include:</p>
<p>Analyze sentiment of tweets, product reviews, social media content or any text using <strong><code>wink-sentiment</code></strong>. It is based on <a href="https://arxiv.org/abs/1103.2903">AFINN</a> and <a href="http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0144296">Emoji Sentiment Ranking</a>; it's features include:</p>
<ol>
<li>Intelligent negation handling; for example, phrase &quot;good product&quot; will get a positive score whereas &quot;not a good product&quot; gets a negative score.</li>
<li>Automatic detection and scoring of two-word phrases in a text; for example, &quot;cool stuff&quot;, &quot;well done&quot;, and &quot;short sighted&quot;.</li>
<li>Processes each emoji, emoticon and/or hashtag separately while scoring.</li>
<li>Embeds a powerful <a href="https://www.npmjs.com/package/wink-tokenizer">tokenizer</a> that returns the tokenized phrase.</li>
<li>Returns the sentiment score and tokens. Each token contains a set of properties defining its sentiment, if any.</li>
<li>Achieves accuracy of 77%, when validated using Amazon Product Review <a href="https://archive.ics.uci.edu/ml/machine-learning-databases/00331/">Sentiment Labelled Sentences Data Set</a> at
<a href="https://archive.ics.uci.edu/ml/index.php">UCI Machine Learning Repository</a>.</li>
<li>Achieves accuracy of 77%, when validated using Amazon Product Review <a href="https://archive.ics.uci.edu/ml/machine-learning-databases/00331/">Sentiment Labelled Sentences Data Set</a> at <a href="https://archive.ics.uci.edu/ml/index.php">UCI Machine Learning Repository</a>.</li>
</ol>
<h3>Installation</h3><p>Use <a href="https://www.npmjs.com/package/wink-sentiment">npm</a> to install:</p>
<pre class="prettyprint source"><code>npm install wink-sentiment --save</code></pre><h3>Example</h3><pre class="prettyprint source lang-javascript"><code>// Load wink-sentiment package.
Expand All @@ -86,9 +84,9 @@ <h3>Installation</h3><p>Use <a href="https://www.npmjs.com/package/wink-sentimen
// ]
// }</code></pre><h3>Documentation</h3><p>Check out the <a href="http://winkjs.org/wink-sentiment/">wink sentiment API</a> documentation to learn more.</p>
<h3>Need Help?</h3><p>If you spot a bug and the same has not yet been reported, raise a new <a href="https://github.com/winkjs/wink-sentiment/issues">issue</a> or consider fixing it and sending a pull request.</p>
<h3>About wink</h3><p><a href="http://winkjs.org/">Wink</a> is a family of open source packages for <strong>Statistical Analysis</strong>, <strong>Natural Language Processing</strong> and <strong>Machine Learning</strong> in NodeJS. The code is <strong>thoroughly documented</strong> for easy human comprehension and has a <strong>test coverage of ~100%</strong> for reliability to build production grade solutions.</p>
<h3>Copyright &amp; License</h3><p><strong>wink-sentiment</strong> is copyright 2017-18 <a href="http://graype.in/">GRAYPE Systems Private Limited</a>.</p>
<p>It is licensed under the under the terms of the GNU Affero General Public License as published by the Free
Software Foundation, version 3 of the License.</p></article>
<p>It is licensed under the terms of the MIT License.</p></article>
</section>


Expand All @@ -103,7 +101,7 @@ <h3>Copyright &amp; License</h3><p><strong>wink-sentiment</strong> is copyright
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 11 2018 12:36:18 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 08 2018 12:26:31 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
29 changes: 16 additions & 13 deletions docs/wink-sentiment.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,23 @@ <h1 class="page-title">wink-sentiment.js</h1>
//
// This file is part of “wink-sentiment”.
//
// “wink-sentiment” is free software: you can redistribute
// it and/or modify it under the terms of the GNU Affero
// General Public License as published by the Free
// Software Foundation, version 3 of the License.
// 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:
//
// “wink-sentiment” is distributed in the hope that it will
// be useful, but WITHOUT ANY WARRANTY; without even
// the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU Affero General
// Public License for more details.
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// You should have received a copy of the GNU Affero
// General Public License along with “wink-sentiment”.
// If not, see &lt;http://www.gnu.org/licenses/>.
// 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.

//
var emojis = require( './emojis.js' );
Expand Down Expand Up @@ -260,7 +263,7 @@ <h1 class="page-title">wink-sentiment.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Oct 11 2018 12:36:18 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 08 2018 12:26:31 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
Loading

0 comments on commit b4c92d6

Please sign in to comment.