Added documentation for AFINN, returned objects and tokenization. #124
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CI fail fix
Indent fix
Added how it works; AFINN, tokenization and returned objects info.
thisandagain
requested changes
Oct 11, 2017
| @@ -79,7 +79,62 @@ Yelp: 0.69 (+2%) | |||
| ``` | |||
|
|
|||
| --- | |||
| ### How it works | |||
| #### AFINN | |||
| AFINN is a list of words rated for valence with an integer between minus five (negative) and plus five (positive). Sentiment analysis is performed by cross-checking the string tokens( words, emojis) with the AFINN list and getting their respective scores. The comparative score is simply: sum of each token / number of tokens. So for example let's take the following: | |||
There was a problem hiding this comment.
Couple minor nitpicks here:
- Fix spacing / formatting in parenthetical "tokens (e.g. words and emojis)"
- Format "sum of each token / number of tokens" as code by wrapping in
code
| (5 * 200) / 200 = 5 | ||
|
|
||
| #### Tokenization | ||
| Tokenization works by splitting the lines of input string, then removing the special characters and finally splitting it using spaces. This is used to get list of words in the string. |
There was a problem hiding this comment.
Another really minor nitpick:
- Please use an oxford comma for "characters, and finally"
| @@ -79,7 +79,62 @@ Yelp: 0.69 (+2%) | |||
| ``` | |||
|
|
|||
| --- | |||
| ### How it works | |||
There was a problem hiding this comment.
I think this whole section should probably be before "Benchmarks". Also, please match the spacing between the H3 and the divider line as shown in the other sections:
... lorem ipsum dolor sit amet.
---
### Some title
Lorem ipsum dolor sit amet...|
|
||
| This approach leaves you with a mid-point of 0 and the upper and lower bounds are constrained to positive and negative 5 respectively (the same as each token! 😸). For example, let's imagine an incredibly "positive" string with 200 tokens and where each token has an AFINN score of 5. Our resulting comparative score would look like this: | ||
|
|
||
| (max positive score * number of tokens) / number of tokens |
There was a problem hiding this comment.
Please wrap this and the line below it in a code block
| * __Negative__: List of negative words in input string that were found in AFINN list. | ||
|
|
||
| In this case, love has a value of 3, allergic has a value of -2, and the remaining tokens are neutral with a value of 0. Because the string has 9 tokens the resulting comparative score looks like: | ||
| (3 + -2) / 9 = 0.111111111 |
There was a problem hiding this comment.
Please wrap this line in a code block
|
I fixed these in #125. Please take a look. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.