{"id":21273486,"url":"https://github.com/graphaware/hume-workshop","last_synced_at":"2025-07-04T06:06:48.677Z","repository":{"id":69925612,"uuid":"310435152","full_name":"graphaware/hume-workshop","owner":"graphaware","description":null,"archived":false,"fork":false,"pushed_at":"2020-11-06T16:39:02.000Z","size":70,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-07-04T06:06:47.757Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/graphaware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-05T22:46:28.000Z","updated_at":"2020-11-06T16:30:18.000Z","dependencies_parsed_at":"2023-04-15T19:31:52.463Z","dependency_job_id":null,"html_url":"https://github.com/graphaware/hume-workshop","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/graphaware/hume-workshop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphaware%2Fhume-workshop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphaware%2Fhume-workshop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphaware%2Fhume-workshop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphaware%2Fhume-workshop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphaware","download_url":"https://codeload.github.com/graphaware/hume-workshop/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphaware%2Fhume-workshop/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263457182,"owners_count":23469289,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T09:15:01.024Z","updated_at":"2025-07-04T06:06:48.669Z","avatar_url":"https://github.com/graphaware.png","language":"Shell","readme":"# NLP with GraphAware Hume\n\nThis repository contains a trial version of Hume for the Nodes 2020 event. Participants will receive credentials through their registration that they have to use\nduring the instructions described below.\n\n## Requirements\n\n- A laptop or a server with 5-6GB of memory.\n- Docker and Docker Compose installed\n\n## Installation\n\nThe following procedure will install the necessary containers for running Hume : \n\n- Neo4j 4.1.2\n- Hume\n- Hume Entity Extraction Service\n- Hume Keyword Extraction Service\n\n### Login to the GraphAware Docker registry\n\n```bash\ndocker login docker.graphaware.com\n```\n\nand provide the credentials that have been given to you during the registration.\n\n### Pull the containers\n\n```\ndocker-compose pull\n```\n\n### Start Hume\n\n```\ndocker-compose up -d\n```\n\nit can take some minutes to start depending on your machine. \n\nOnce the start-up phase will have finished, head to `http://localhost:8081`: you will see the sign-up page.\n\n### Inspect logs\n\nIf something is not working as expected, inspect the logs : \n\n```\ndocker-compose logs -f\n```\n\n### Recommended memory settings\n\n#### Linux hosts\n\nOn Linux hosts, by default, a Docker container has no resource constraints and can use as much of a given resource as the kernel scheduler allows.\n\n#### MacOS and MS Windows hosts\n\nOn Windows and Mac OS, Docker Engine runs on top of a lightweight virtual machine (VM), which can be handled via Docker Desktop. \nThus, in these environments, only a part of hosts' memory is reserved to this VM; this portion of memory represents the upper limit of the memory that Hume can use.\n\nBy default, Docker Desktop is set to use 2 GB runtime memory, allocated from the total available memory on your Mac/Windows machine.\n\nWhen running Hume with these default RAM settings, if the kernel detects that there is not enough memory to perform important system functions, it throws an Out Of Memory Exception (OOME), and starts killing processes to free up memory.\nFor instance, in case of intensive data ingestion, Neo4j can easily run out of memory, and then its process can be killed by OOM killer.\n\nIn order to avoid this kind of events, we strongly recommend increasing the amount of RAM via Docker Desktop. \nTo do so, head to `Preferences -\u003e Resources -\u003e Advanced` and increase `Memory` at least to 6 GB.\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphaware%2Fhume-workshop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphaware%2Fhume-workshop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphaware%2Fhume-workshop/lists"}