A media analysis service. Part of the Check platform. Refer to the main repository for quick start instructions.
- Update your virtual memory settings, e.g. by setting
vm.max_map_count=262144
in/etc/sysctl.conf
. This can also be done by the Docker UI, adjusting Resource settings to 12GB memory and 128GB of disk. - Ensure that the services needed are uncommented in the
docker-compose.yml
file. Specifically, to run the default tests thexlm_r_bert_base_nli_stsb_mean_tokens
,indian_sbert
,video
andaudio
definitions are needed. docker-compose build
docker-compose up --abort-on-container-exit
- Open http://localhost:3100 for the Alegre API
The Alegre API Swagger UI unfortunately does not support sending body payloads to GET methods. To test those API methods, you can still fill in your arguments, and click "Execute" - Swagger will fail, but show you a curl
command that you can use in your console.
- Open http://localhost:9200 for the OpenSearch API
docker-compose exec alegre flask shell
to get inside a Python shell in docker container with the loaded app
- For the full set of tests to pass, some configuration secrets are required (i.e. Google Translate API keys, etc)
docker-compose -f docker-compose.yml -f docker-test.yml up --abort-on-container-exit
- Wait for the logs to settle, then in a different console:
docker-compose exec alegre make test
docker-compose exec alegre coverage report
To test individual modules:
docker-compose exec alegre bash
(opens a bash shell with appropriate environment in the docker container)python manage.py test -p test_similarity.py
- If you're having trouble starting OpenSearch on macOS, with the error
container_name exited with code 137
, you will need to adjust your Docker settings, as per https://www.petefreitag.com/item/848.cfm - Note that the alegre docker service definitions in the
alegre
repo may not align with the alegre service definitions in thecheck
repository, so different variations of the service may be spun up depending on the directory wheredocker-compose up
is executed.
(Source: https://docs.google.com/drawings/d/1-teqtZJfU4MSDUGVwWL9F4cXDKDnVObDYg3a9jJOP1Y/edit)
(Source: https://docs.google.com/drawings/d/1jvwn5wM6T2jlnaS_fS7_u6sH02HVHi6L8Q9H_vD4SuY/edit)