keep-current / engine Goto Github PK

The readme is outdated, and should be aligned and resemble to the one of Web-Miner.
Including running instructions and the reference to the facebook group.

Helps to make contributions similar.

includes:

• Contribution.md
• Templates for Issues, PRs
• VSCode Settings
• Formatting
• Linting

Add the ability to install the dependencies through pipenv, and alter the readme to guide the users how to install the dependencies through it.

Remove old content of contribution.md

Add a dockerfile to the repository, using gunicorn as the flask server initializer.
Add to the README.md file instructions how to setup and have the engine running with minimal effort

@liadmagen 's idea: https://www.kdnuggets.com/2018/07/cookiecutter-data-science-organize-data-project.html

Currently there is just a requirements.txt file with false naming which causes errors

Create an easy way to compare documents through their contents, using Doc2Vec
Read this blog post for background and details about this algorithm:
https://medium.com/scaleabout/a-gentle-introduction-to-doc2vec-db3e8c0cce5e

To do so, you should first - have a REST API methods to:

• convert a single document to a vector
• convert multiple documents (array of strings) to an array of vectors
• given two vectors, return the distance between them
• given two documents, convert them to vectors and return the distance (similarity) between them

The link to "Code of Conduct" is directing to a 404

Flask-script is no longer maintained.
It should be replaced with the flask CLI to
flask run