Need better documentation to run in client/server mode
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 5k
- Forks
- 622
- Avg merge
- 8h 37m
- Merged PRs (30d)
- 5
Description
Describe the bug
I haven't been able to figure out how to run SPTAG in a server/client mode on Ubunt 18.04. I want to host SPTAG on a cloud server and run a python client to perform kNN lookups.
For example, the documentations states thus:
./Server [options]
Options:
-m, --mode <value> Service mode, interactive or socket.
-c, --config <value> Configure file of the index
:
But I can't seem to find the Server binary. I see a lowercase server binary in the Release folder, but it doesn't accept these arguments and gives an error:
Command 'server' not found, but can be installed with:
apt install rsplib-legacy-wrapper
Can someone post a simpler guide to using SPTAG in client/server mode for us noobs?
Thanks for such a wonderful tool!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing client/server documentation and the Server and lowercase server entry points in the Release folder. Reproduce the command-line behavior on Ubuntu 18.04, then document how to start SPTAG in server mode and connect a Python client for kNN lookups. Done means a newcomer can follow the guide without confusing the two binaries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python, ubuntu
- Domain
- distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100