Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md to call out GPU support #38

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Update README.md to call out GPU support #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f39e6d
Update README.md to call out GPU support
rbavery Nov 14, 2023
9d69a85
update README
rbavery Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,10 @@ docker run -it --rm \
```

### (Potentially) Frequently Asked Questions
Q: What GPUs was this tested with?

A: The encoder and decoder are tested locally with a 1080 Ti (Pascal) and 3090 (Ampere). In production, the encoder runs on a p3.2xlarge (Tesla V100). Older Kepler GPUs such as K80s are not tested. See [this issue](https://github.com/developmentseed/segment-anything-services/issues/36) for guidance on adapting the docker images to work with Kepler series GPUs.

Q: Why two services?

A: We're exploring cost effective ways to run image encoding in a separate, on-demand way from the CPU decoder. Eventually we'd like to remove the need for the CPU torserve on the backend and run the decoding in the browser.
Expand All @@ -124,6 +128,20 @@ Q: Can I contribute or ask questions?

A: This is currently more of a "working in the open" type repo that we'd like to share with others, rather than a maintained project. But feel free to open an issue if you have an idea. Please understand if we don't respond or are slow to respond.

### Contributing and packaging

We use hatch to build the sam-serve package. This wheel file is built from source when building the cpu or gpu docker images. We also use hatch to publish the package to PYPI. We don't have CI CD yet, so if you are interested in contributing, increment the version in your PR and notify the maintainers @rbavery or @rub21 and we will publish the package on PR merge.

The main commands are

`hatch build` to make the whl file

`hatch publish` to publish a release

hatch can be installed with pip or pipx

`pip install hatch`

## License

The model and code is licensed under the [Apache 2.0 license](LICENSE).
Expand Down
Loading