Package: comment-recommendation-framework
Comment Recommendation FrameworkThe Comment Recommendation Framework is a modular approach to support scientists in the development of prototypes for
comment recommendation systems that can be used in real-world scenarios. The advantage of such a system is that it
relieves the scientist from the majority of the technical code and only prototype-specific components have to be developed. In this way, the researchers can invest
more time in the development of recommendation models and less time has to be spent in the development of a prototype
while at the same time getting prototypes that can be used in real-world settings.SetupEnsure that the following tools are installed:DockerDocker-ComposePyhon >= 3.10DocumentationTo build the latest version of the documentation, please run in the docs folder:$ make clean && make htmlThen you find the latest documentationhereEnvironment VariablesThe framework need some environment variables to be set for running properly. Please ensure that you have an.envfile with the following variables:NEO4J_PASSWORDNEO4J_BOLT_URL (Format:bolt://neo4j:<NEO4J_PASSWORD>@neo4j:7687)Run the Comment Recommendation FrameworkInstall the package locallyTo install the package locally, you have to build it first. For this, run in the folder withsetup.py:python3 -m buildPlease make sure that the build library is installed. Otherwise, you cannot build the package.This creates adistfolder at your current location with two filesComment-Recommendation-Framework-X.X.X.tar.gzandComment_Recommendation_Framework-X.X.X-py3-none-any.whl. Thetar.gzfile is thesource distributionand the.whlis thebuilt distribution.We recommend to create avirtual environmentto isolate your project from
the rest of your system to prevent import and version problems.Then you run inside your virtual environment:pip install <path_to_the_whl_file>Create your projectTo create the system template you run the following command in your virtual env after you have installed the package:python3 -m comment_recommendation_frameworkThen the package asks you different questions to determine which modules you need for your project. You can answer them
withyfor yes andnfor no.Run different moduls with docker-composeWe provide you with the followingdocker-composefiles to run the different components of the recommendation framework.docker-compose.scraping.yml: Runs the news agency scraper to retrieve articles and comments from various news agencies.docker-compose.embed.yml: Starts the embedding process to compute the embeddings for the comments and articles. Should be run directly afterdocker-compose.scraping.yml.docker-compose.csv.yml: Imports comments and articles from a csv file into the database.docker-compose.test.yml: Runs the tests for the system.docker-compose.api.yml: Runs the comment-recommendation systems.User-InterfaceIf you would like to use the default user interface. You have to install the npm packages and build the chrome extension.
For this you have to run in theUIfolder:$npminstalland afterwards:$npmrunbuildThen you can import thebuildfolder in a chromium browser.Maintainers:Jan SteimannContributors:Jan SteimannLicense:Copyright(c) 2024 - today Jan SteimannDistributed under theMIT License