Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better quality documentation #123

Open
clocked0ne opened this issue Nov 22, 2018 · 0 comments
Open

Better quality documentation #123

clocked0ne opened this issue Nov 22, 2018 · 0 comments

Comments

@clocked0ne
Copy link

clocked0ne commented Nov 22, 2018

The documentation overall is very light and some of it is inaccurate, for instance new SentimentAnalyzer({ language: 'en' }).getSentiment() does not return a Promise even though the documentation shows it used with .then() in all examples.

There is also no examples of what the score and comparitive values represent or a small overview of how some of the processes work and what the results mean. Again with Sentiment Analysis I can guess that scores > 0 are positive and < 0 are negative, but what are the value ranges this sits between? If I get back a value of 8 is that a lot more positive than 0.25, or only marginally positive/almost neutral?

What are the comparative values for, what do they represent. A little time spent on this would make it a lot easier to understand and work with as it seems like a great way to cleanly and easily introduce NLP to a development team.

Kind of also ties in with #121

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant