{"id":15941690,"url":"https://github.com/tucan9389/image-clustering-browser","last_synced_at":"2026-04-15T09:32:00.239Z","repository":{"id":109497366,"uuid":"324093729","full_name":"tucan9389/image-clustering-browser","owner":"tucan9389","description":null,"archived":false,"fork":false,"pushed_at":"2020-12-28T08:21:18.000Z","size":258,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-03T21:16:31.033Z","etag":null,"topics":["clustering","faiss","flask","k-means-clustering","react","viewer","vision"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tucan9389.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}},"created_at":"2020-12-24T07:22:20.000Z","updated_at":"2021-11-30T07:50:32.000Z","dependencies_parsed_at":"2023-05-15T05:45:48.854Z","dependency_job_id":null,"html_url":"https://github.com/tucan9389/image-clustering-browser","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tucan9389/image-clustering-browser","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tucan9389%2Fimage-clustering-browser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tucan9389%2Fimage-clustering-browser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tucan9389%2Fimage-clustering-browser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tucan9389%2Fimage-clustering-browser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tucan9389","download_url":"https://codeload.github.com/tucan9389/image-clustering-browser/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tucan9389%2Fimage-clustering-browser/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31834536,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T07:17:56.427Z","status":"ssl_error","status_checked_at":"2026-04-15T07:17:30.007Z","response_time":63,"last_error":"SSL_read: 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":["clustering","faiss","flask","k-means-clustering","react","viewer","vision"],"created_at":"2024-10-07T07:20:32.541Z","updated_at":"2026-04-15T09:32:00.201Z","avatar_url":"https://github.com/tucan9389.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Image Clustering Browser\n\nYou can browse clustered images on web. This repo also provides clustering with with [faiss](https://github.com/facebookresearch/faiss) similarity and [k-means](https://en.wikipedia.org/wiki/K-means_clustering) clustering algorithm.\n\n## DEMO\n\n![clustering-viewer-demo-coco-dataset-3-3](https://user-images.githubusercontent.com/37643248/103138522-d0a10c00-4716-11eb-84d8-5bbe21e137f1.gif)\n\n## Features\n\n- Server (python 3.6+, flask)\n\n  - [x] Serve hierarchical directories browsing api\n  - [x] Serve images serving api\n\n- Client (javscript, react)\n  - [x] View the result of clustering with huge number of images\n  - [x] Browse the hierarchical directories\n  - [x] Show bunch of images with grid gallery view and paginization\n- Others\n  - [x] Without copying images, cluster million level images and write at txt files (faiss)\n  - [ ] Make featuremaps with images\n  - [ ] Run clustering with buttons and show the progress of the task on the web\n  - [ ] Show the featuremaps for each image\n  \n## Diagram\n\n\u003cimg src=\"https://user-images.githubusercontent.com/37643248/103156156-407fc700-47e9-11eb-88be-4ac6b08e298c.png\" width=600px\u003e\n\n## Getting Started\n\n### 0. Clone the project\n\n```shell script\n$ git clone https://github.com/tucan9389/image-clustering-browser\ncd image-clustering-browser\n```\n\n### 1. Install Requirements\n\n1. [Install anaconda](https://docs.anaconda.com/anaconda/install/) and pathon 3.6+\n3. Install python libraries for clustering batch and api server\n\n```shell script\n$ pip install numpy Flask Flask-Cors\n```\n\n4. [Install yarn](https://classic.yarnpkg.com/en/docs/install/) for react app\n5. yarn install on browser-react directory\n\n```shell script\n$ cd browser-react\n$ yarn install\n```\n\n### 2. Prepare Images and Clustering Result\n\nYou can select one of the options:\n\n- Download sample data from [image data(19.31GB)](https://drive.google.com/drive/folders/1qY3i-JaR0txMU4UIuVJ65WKUCBQASEL6?usp=sharing) and [clustering data(1.3MB)](https://drive.google.com/drive/folders/1gHwcpuV8bp8-6PeNlyY5yazGIgY0SU7w?usp=sharing) \n- Or make your own clustering with [CLUSTERING_GUIDE.md](CLUSTERING_GUIDE.md)\n\n\n\u003cdetails\u003e\n\u003csummary\u003eThe clustering makes the directory structure. If you make cluster by yourself, you have to conform the structure.\u003c/summary\u003e\n\n```\n../data/clutering-results\n└── my-images-001-clustering\n    ├── img_names.txt\n    ├── 20201225-160650-d999-c5\n    |   ├── 000\n    |   |   └── img_names.txt\n    |   ├── 001\n    |   |   └── img_names.txt\n    |   ├── 002\n    |   |   └── img_names.txt\n    |   ├── 004\n    |   |   └── img_names.txt\n    |   └── etc\n    |       └── img_names.txt\n    └── 20201225-170423-d999-c3\n        ├── 000\n        |   └── img_names.txt\n        ├── 001\n        |   └── img_names.txt\n        |   └── 20201226-034123-d103-c3\n        |       ├── 000\n        |       |   └── img_names.txt\n        |       ├── 001\n        |       |   └── img_names.txt\n        |       └── 002\n        |           └── img_names.txt\n        └── 002\n            └── img_names.txt\n```\n\u003c/details\u003e\n\n### 3. Run Browser API and Client Server\n\n\nAnd then, run the server and client app.\n\n```shell script\n# run api server\n$ cd browser-server\n$ python app.py \\\n    --img_dir_path \"../data/my-images-001\" \\\n    --clustering_output_path \"../data/clutering-results/my-images-001-clustering\"\n\n# and then run client server\n$ cd ../browser-react\n$ yarn start\n```\n\nNow you can browse the clustered images at [`http://localhost:3000/browser/`](`http://localhost:3000/browser/`).\n\n## Used Libraries\n\n- [React](https://reactjs.org/)\n- [Flask](https://palletsprojects.com/p/flask/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftucan9389%2Fimage-clustering-browser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftucan9389%2Fimage-clustering-browser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftucan9389%2Fimage-clustering-browser/lists"}