Bothub is an open platform for predicting, training and sharing NLP datasets in multiple languages.
BotHub is an NLP as a service tool that enables users to build, improve or translate datasets that extracts metadata from text.
You can read more about the project's purpose on this blog post.
This repo is the "master" repo for all Bothub-related projects. It hosts the documentation and other misc. resources for Bothub. Code for other projects, like the WebApp, Engine, NLP Worker, NLP API and NLP On Demand, are hosted in other repositories.
All documentation available on docs.bothub.it.
Instead of using standard Docker commands, you may want a little more automated management of your deployment. This is where using Docker-compose can be useful.
- Make sure Docker and Docker-compone are installed and operational.
- Check if your docker-swarm is enabled, if not, go to the configuration session.
- Edit image: bothubit/bothub-(project): develop to specify which image you want to use (see the section Images available in Docker)
Add two networks for internal project communication:
docker network create bothub-nlp -d overlay
docker network create postgres -d overlay
Then add docker-compose.yml with docker stack
docker stack deploy --compose-file=docker-compose.yml bothub
after carrying out all the deploy, check if all containers were started with the command:
docker service ls
If it is the first time that you have run the project, you will need to run the migrations to create the tables in the database, for this run the command:
make engine_migration
to populate the database with fakes data, you can use the command:
make engine_fakedata
This docker stack process allows you to upload our services quickly, it automatically downloads our images generated from the Docker Hub itself. With that you have practically moved up our entire stack, you will only be missing the frontend.
To build the bothub-webapp project you need to have the dependencies installed correctly:
| # | Version |
|---|---|
| git | >= 2.x.x |
| nodejs | >= 12.x.x |
| yarn | >= 1.x.x |
To install the project you must clone the project:
make clone_webapp
Then, you can notice that a new folder was created with the project code bothub-webapp, just access the directory with the command:
cd bothub-webapp
and install the project dependencies with the yarn command:
yarn install
after installing the dependencies, just start bothub-webapp's development server with the command:
yarn start
this way you will already be able to use our entire stack, remembering that each project has its environment variables configurable, to change consult the documentation for each specific project.
We are looking for collaboration from the Open Source community! There's so much we want to do, including but not limited to: enhancing existing applications with new features, optimizing the NLP tools and algorithms involved that boost accuracy, and bringing our work closer to the public to leverage their inputs via blog posts and tutorials.
-
Please read our contribution guidelines for details on what and how you can contribute.
-
Report a bug by using this guideline for details on what and how you can contribute.
The issues created here will be analysed and validated. They can be submitted to the bothub, bothub-webapp, and/or bothub-nlp repository as well.
The issue tracker is the preferred channel for bug reports and features requests, but please respect the following restrictions:
-
Please do not use the issue tracker for personal support requests (send an email to [email protected]).
-
Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
To request a new feature, create a new issue using the label feature request.