{"id":15693334,"url":"https://github.com/joshdevins/sherlock","last_synced_at":"2025-05-08T03:49:09.900Z","repository":{"id":13379004,"uuid":"16066936","full_name":"joshdevins/sherlock","owner":"joshdevins","description":"A tiny fingerprint index and search based on the Philips hashing algorithm","archived":false,"fork":false,"pushed_at":"2014-03-17T15:44:03.000Z","size":256,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-05-08T03:48:59.954Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"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/joshdevins.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-20T09:56:54.000Z","updated_at":"2023-11-09T01:26:18.000Z","dependencies_parsed_at":"2022-08-22T23:50:16.823Z","dependency_job_id":null,"html_url":"https://github.com/joshdevins/sherlock","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshdevins%2Fsherlock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshdevins%2Fsherlock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshdevins%2Fsherlock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshdevins%2Fsherlock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshdevins","download_url":"https://codeload.github.com/joshdevins/sherlock/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252996198,"owners_count":21837616,"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-10-03T18:42:58.129Z","updated_at":"2025-05-08T03:49:09.868Z","avatar_url":"https://github.com/joshdevins.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sherlock\n\nFingerprint indexing, searching, matching. You know, general sleuthing.\n\n[![Build Status](https://travis-ci.org/joshdevins/sherlock.png)](https://travis-ci.org/joshdevins/sherlock)\n\n## Objectives\n\n* understand, at a fundamental level, the index and searching algorithm from the\n  Philips hashing paper [1]\n* ideally, provide an evaluation harness allowing easy tuning of parameters\n\n## HTTP API\n\n* POST `/index`\n* POST `/search`\n  * `approx_search_strategy=[none|flip]` the approximate search strategy to\n    use when generating candidates\n  * `max_hamming_distance=[int]` the maximum Hamming distance to consider for a\n    candidate sub-fingerprint when performing a bit flipping approximate search\n    strategy\n  * `ber=[float]` the upper bound threshold of the bit error rate for use when\n    comparing fingerprint blocks between query and candidate\n* GET `/-/stats` shows statistics about the index\n\nThe HTTP POST body used in the HTTP API should be a protocol buffer encoded\nfingerprint, octet binary encoded for HTTP. The schemas are defined in\n`fingerprint.proto` and are index and query specific.\n\n## Bibliography\n\n[1] J. Haitsma and A. Kalker, “A Highly Robust Audio Fingerprinting System,” in\n_Proc. International Symposium on Music Information Retrieval (ISMIR)_, 2002.\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2014 Josh Devins\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshdevins%2Fsherlock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshdevins%2Fsherlock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshdevins%2Fsherlock/lists"}