{"id":28966298,"url":"https://github.com/dice-group/palmetto","last_synced_at":"2025-06-24T07:33:03.196Z","repository":{"id":13710504,"uuid":"16404471","full_name":"dice-group/Palmetto","owner":"dice-group","description":"Palmetto is a quality measuring tool for topics","archived":false,"fork":false,"pushed_at":"2024-02-12T10:58:33.000Z","size":5538,"stargazers_count":203,"open_issues_count":8,"forks_count":37,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-02-12T11:55:58.944Z","etag":null,"topics":["evaluation","topic-coherence","topic-modeling"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dice-group.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-31T09:49:32.000Z","updated_at":"2024-01-04T15:56:08.000Z","dependencies_parsed_at":"2023-01-13T17:35:27.671Z","dependency_job_id":null,"html_url":"https://github.com/dice-group/Palmetto","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/dice-group/Palmetto","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dice-group%2FPalmetto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dice-group%2FPalmetto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dice-group%2FPalmetto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dice-group%2FPalmetto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dice-group","download_url":"https://codeload.github.com/dice-group/Palmetto/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dice-group%2FPalmetto/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261627916,"owners_count":23186718,"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":["evaluation","topic-coherence","topic-modeling"],"created_at":"2025-06-24T07:31:22.904Z","updated_at":"2025-06-24T07:33:03.144Z","avatar_url":"https://github.com/dice-group.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Maven Build](https://github.com/dice-group/Palmetto/actions/workflows/maven.yml/badge.svg)](https://github.com/dice-group/Palmetto/actions/workflows/maven.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/0b0a42e905454c7cacb61243c76316a0)](https://www.codacy.com/gh/dice-group/Palmetto/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=dice-group/Palmetto\u0026amp;utm_campaign=Badge_Grade) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/0b0a42e905454c7cacb61243c76316a0)](https://www.codacy.com/gh/dice-group/Palmetto/dashboard?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=dice-group/Palmetto\u0026utm_campaign=Badge_Coverage)\n\n\u003cimg src=\"https://hobbitdata.informatik.uni-leipzig.de/homes/mroeder/palmetto/palmetto_64px.png\" align=\"left\" /\u003e\n\nPalmetto\n========\n\u003ci\u003e\u003cb\u003eP\u003c/b\u003ealmetto is a qu\u003cb\u003eal\u003c/b\u003eity \u003cb\u003eme\u003c/b\u003easuring \u003cb\u003et\u003c/b\u003eool for \u003cb\u003eto\u003c/b\u003epics\u003c/i\u003e\n\nThis is the implementation of coherence calculations for evaluating the quality of topics. If you want to learn more about coherence calculations and their meaning for topic evaluation, take a look at the \u003ca href=\"https://dice-research.org/Palmetto\"\u003eproject page\u003c/a\u003e or have a look at our publication [\"Exploring the Space of Topic Coherence Measures\"](https://papers.dice-research.org/2015/WSDM_Palmetto/WSDM_palmetto_public.pdf).\n\n\u003cspan xmlns:dct=\"http://purl.org/dc/terms/\" property=\"dct:title\"\u003ePalmetto\u003c/span\u003e from \u003ca xmlns:cc=\"http://creativecommons.org/ns#\" href=\"http://cs.uni-paderborn.de/ds/\" property=\"cc:attributionName\" rel=\"cc:attributionURL\"\u003eDICE\u003c/a\u003e is licensed under a \u003ca rel=\"license\" href=\"https://www.gnu.org/licenses/agpl.txt\"\u003eAGPL v3.0 License\u003c/a\u003e.\n\nPlease take a look at the the wikipage to read \u003ca href=\"https://github.com/AKSW/Palmetto/wiki/How-Palmetto-can-be-used\"\u003ehow Palmetto can be used\u003c/a\u003e. If you would like to use a different index than the one we are providing, you can \u003ca href=\"https://github.com/dice-group/Palmetto/wiki/How-to-create-a-new-index\"\u003ecreate your own index\u003c/a\u003e.\n\nIf you are using Palmetto for an experiment or something similar that leads to a publication, please cite the paper [\"Exploring the Space of Topic Coherence Measures\"](https://papers.dice-research.org/2015/WSDM_Palmetto/WSDM_palmetto_public.pdf) (you can find the Bibtex [below](#citation)). A link to the project website is welcome as well 🙂\n\n### Applicability\n\nThe coherence measures implemented with Palmetto mainly built on a reference index. This index is used to derive counts for the calculation of the coehrence values. These values can be used to measure the human interpretability of topics based on the topics' top words. It should be noted that the preprocessing of the index has an influence on the results. \n\n_It is highly suggested to use an index that fits to the preprocessing that has been applied to the corpus on which the topics have been generated._\n\nWe use an English Wikipedia which has been preprocessed using a Lemmatizer. In practice, this means that word groups with non-lemmatized words may lead to unintuitive results simply because these word forms are underrepresented or even missing in our index (e.g., #57). In these cases, it is recommended to [generate an own index](https://github.com/dice-group/Palmetto/wiki/How-to-create-a-new-index).\n\n### Directories\n\nThe `palmetto` directory contains the Palmetto library.\n\nThe `webApp` directory contains a web application offering a small demo as well as a web service API for using Palmetto.\n\n### Docker\n\nPalmetto can be used as a docker container.\n\n[The index](https://hobbitdata.informatik.uni-leipzig.de/homes/mroeder/palmetto/Wikipedia_bd.zip) should be downloaded and extracted to some path (for example, `/path/to/indexes`). After extraction, the directory should contain the `wikipedia_bd` directory and the `wikipedia_bd.histogram` file.\n```\npath\n+- to\n  +- indexes\n    +- wikipedia_bd\n    +- wikipedia_bd.histogram\n```\nAfter that, the container can be run the following way:\n```\ndocker run -p 7777:8080 -d -v /path/to/indexes/:/usr/local/indexes/:ro dicegroup/palmetto-service\n```\nAfter that the demo application can be accessed using `http://localhost:7777/`.\n\n#### Adapted Docker image\n\nIn case the Palmetto code has been adapted locally, the Docker image can be build with the following command:\n```\nmake build dockerize\n```\n\n### Citation\n```bibtex\n@inproceedings{roeder2015palmetto,\n    title = {{Exploring the Space of Topic Coherence Measures}},\n    author = {R\\\"{o}der, Michael and Both, Andreas and Hinneburg, Alexander},\n    year = {2015},\n    isbn = {9781450333177},\n    publisher = {Association for Computing Machinery},\n    address = {New York, NY, USA},\n    url = {https://doi.org/10.1145/2684822.2685324},\n    doi = {10.1145/2684822.2685324},\n    booktitle = {Proceedings of the Eighth ACM International Conference on Web Search and Data Mining},\n    pages = {399–408},\n    numpages = {10},\n    keywords = {topic coherence, topic evaluation, topic model},\n    location = {Shanghai, China},\n    series = {WSDM '15}\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdice-group%2Fpalmetto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdice-group%2Fpalmetto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdice-group%2Fpalmetto/lists"}