{"id":15913021,"url":"https://github.com/x-tabdeveloping/topic-benchmark","last_synced_at":"2026-01-17T22:17:28.975Z","repository":{"id":224693633,"uuid":"759713209","full_name":"x-tabdeveloping/topic-benchmark","owner":"x-tabdeveloping","description":"Just Benchmarking Topic Models :)","archived":false,"fork":false,"pushed_at":"2025-05-14T12:42:54.000Z","size":32697,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-14T12:46:16.559Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/x-tabdeveloping.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-19T07:38:08.000Z","updated_at":"2024-11-15T07:47:04.000Z","dependencies_parsed_at":"2024-02-27T10:27:53.849Z","dependency_job_id":"6d37229a-f461-442a-8bc9-51a8db076d5d","html_url":"https://github.com/x-tabdeveloping/topic-benchmark","commit_stats":null,"previous_names":["x-tabdeveloping/topic-benchmark"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/x-tabdeveloping/topic-benchmark","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-tabdeveloping%2Ftopic-benchmark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-tabdeveloping%2Ftopic-benchmark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-tabdeveloping%2Ftopic-benchmark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-tabdeveloping%2Ftopic-benchmark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/x-tabdeveloping","download_url":"https://codeload.github.com/x-tabdeveloping/topic-benchmark/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x-tabdeveloping%2Ftopic-benchmark/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28519880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T22:11:28.393Z","status":"ssl_error","status_checked_at":"2026-01-17T22:11:27.841Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-10-06T16:22:30.736Z","updated_at":"2026-01-17T22:17:28.723Z","avatar_url":"https://github.com/x-tabdeveloping.png","language":"Python","readme":"# topic-benchmark\nCommand Line Interface for benchmarking topic models.\n\nThe package contains `catalogue` registries for all models, datasets and metrics for model evaluation,\nalong with scripts for producing tables and figures for the S3 paper.\n\n## Usage\n\n### Installation\n\nYou can install the package from PyPI.\n\n```bash\npip install topic-benchmark\n\n```\n\n### Commands\n\n#### `run`\n\nRun the benchmark. Defaults to running all models with the benchmark used in Kardos et al. (2024).\n\n```bash\npython3 -m topic_benchmark run\n```\n\n| Argument               | Short Flag | Description                                                                                              | Type                                   | Default         |\n|------------------------|------------|----------------------------------------------------------------------------------------------------------|----------------------------------------|-----------------|\n| `--out_dir OUT_DIR`    | `-o`       | Output directory for the results.                                                                        | `str`                                  | `results/`      |\n| `--encoders ENCODERS`  | `-e`       | Which encoders should be used for conducting runs?                                                       | `str`                                  | `None`          |\n| `--models MODELS`      | `-m`       | What subsection of models should the benchmark be run on.                                                | `Optional[list[str], NoneType]`        | `None`          |\n| `--datasets DATASETS`  | `-d`       | What datasets should the models be evaluated on.                                                         | `Optional[list[str], NoneType]`        | `None`          |\n| `--metrics METRICS`    | `-t`       | What metrics should the models be evaluated on.                                                          | `Optional[list[str], NoneType]`        | `None`          |\n| `--seeds SEEDS`        | `-s`       | What seeds should the models be evaluated on.                                                            | `Optional[list[int], NoneType]`        | `None`          |\n\n\n### Push to hub\n\nPush results to a HuggingFace repository.\n\n```bash\npython3 -m topic_benchmark push_to_hub \"your_user/your_repo\"\n```\n\n| Argument          | Description                                            | Type  | Default    |\n|-------------------|--------------------------------------------------------|-------|------------|\n| `hf_repo`         | HuggingFace repository to push results to.             | `str` | N/A        |\n| `results_folder`  | Folder containing results for all embedding models.    | `str` | `results/` |\n\n## Reproducing $S^3$ paper results\nResult files to all runs in the $S^3$ publication can be found in the `results/` folder in the repository.\nTo reproduce the results reported in our paper, please do the following.\n\nFirst, install this package by running the following command:\n\n```bash\npip install topic-benchmark\npython3 -m topic-benchmark run -o results/\n```\n\nThe results for each embedding model will be found in the `results` folder (unless a value for `--out_file` is explicitly passed).\n\nTo produce figures and tables in the paper, you can use the scripts in the  `scripts/s3_paper/` folder.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fx-tabdeveloping%2Ftopic-benchmark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fx-tabdeveloping%2Ftopic-benchmark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fx-tabdeveloping%2Ftopic-benchmark/lists"}