{"id":28458700,"url":"https://github.com/ynqa/faiss-server","last_synced_at":"2025-07-02T05:31:38.515Z","repository":{"id":66129066,"uuid":"141161554","full_name":"ynqa/faiss-server","owner":"ynqa","description":"faiss serving :)","archived":false,"fork":false,"pushed_at":"2023-09-26T03:27:36.000Z","size":65,"stargazers_count":135,"open_issues_count":3,"forks_count":33,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-07T00:34:42.709Z","etag":null,"topics":["cmake","cpp","docker","faiss","grpc","grpc-python","protobuf"],"latest_commit_sha":null,"homepage":"","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/ynqa.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":"2018-07-16T15:58:49.000Z","updated_at":"2025-05-08T01:05:46.000Z","dependencies_parsed_at":"2025-06-07T00:34:47.315Z","dependency_job_id":"db763bf5-febd-417d-9306-e0e7ed37c26e","html_url":"https://github.com/ynqa/faiss-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ynqa/faiss-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynqa%2Ffaiss-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynqa%2Ffaiss-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynqa%2Ffaiss-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynqa%2Ffaiss-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ynqa","download_url":"https://codeload.github.com/ynqa/faiss-server/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynqa%2Ffaiss-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263081332,"owners_count":23410860,"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":["cmake","cpp","docker","faiss","grpc","grpc-python","protobuf"],"created_at":"2025-06-07T00:34:40.086Z","updated_at":"2025-07-02T05:31:38.507Z","avatar_url":"https://github.com/ynqa.png","language":"Python","readme":"# faiss-server\n\nfaiss-server provides gRPC services to for similarity search using [faiss](https://github.com/facebookresearch/faiss). It is written in C++ and now supports only CPU environments.\n\n## Installation\n\nCurrently, installation is from source only.\n\n```\n$ git clone https://github.com/ynqa/faiss-server\n$ cd faiss-server\n```\n\nTo build faiss-server on your local, please use `cmake`.\n\n```\n$ mkdir build; cd build\n$ cmake ..\n$ make\n```\n\n[Beta] To build as docker image:\n\n```\n$ docker build -t faiss-server .\n```\n\n## Demo\n\n1. Create indexed file, which is composed of the word vectors. Indexed words are on [text8](http://mattmahoney.net/dc/textdata) corpus and those vectors are trained by word2vec model of gensim.\n\n```\n$ python example/indexing/indexing.py\n```\n\n2. Select the indexed file and then execute faiss-server.\n```\n$ ./build/bin/faiss_server -file_path example/indexing/faiss.index\n```\n\n- If you build with docker:\n  ```\n  $ docker run -p 8080:8080 -v $(pwd)/example/indexing:/tmp faiss-server -file_path /tmp/faiss.index\n  ```\n\n3. Throw the requests for similarity search\n```\n$ PYTHONPATH=python python example/client/search.py\n```\n\n## Usage\n\n```\nfaiss_server:\n    -file_path (index file name) type: string default: \"\"\n    -host (host of faiss server) type: string default: \"0.0.0.0\"\n    -port (port of faiss server) type: string default: \"8080\"\n    -top_k (default number of neighbor) type: uint64 default: 5\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fynqa%2Ffaiss-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fynqa%2Ffaiss-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fynqa%2Ffaiss-server/lists"}