microsoft / microsoft/SPTAG

Pip package

Open
#219 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
5k
Forks
622
Avg merge
8h 37m
Merged PRs (30d)
5

Description

As part of my work with the Microsoft Research team, we developed a project that make use of SPTAG to index 30000 datapoints for better search results. We found working with SPTAG challenging for multiple reasons, including the long build time as well as issues with boost versioning in the Dockerfile. To solve this, we decided to create a SPTAG pip installable package that we would like to contribute to the repo. The package is currently stored in a private repository, but we would like to share it with the community in order to reduce the entry barrier when implementing SPTAG in production.

The solution I propose is to provide the pip installable package for indexing in Pypi. This solution also includes a Dockerfile that takes care of all associated UNIX dependencies. However, all cmake and boost dependencies are not required anymore, as they are comprised within the package.

Before launching a PR, I wanted to get see how the main contributors feel about this (since no similar solution has been provided even though this issue was already raised in 2019). Happy to discuss any technical questions about the package.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's existing Dockerfile and its CMake and Boost dependency handling. Then examine the proposed pip-installable package and its Dockerfile for the required UNIX dependencies. Done means the maintainers agree on the package scope and the project has a supported PyPI distribution without requiring users to manage the current dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, docker, python
Domain
build-system, devops, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.