Skip to content

Commit

Permalink
docs: add features section on README
Browse files Browse the repository at this point in the history
  • Loading branch information
SauravMaheshkar committed Aug 1, 2024
1 parent 54858d4 commit 54d1866
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
11 changes: 10 additions & 1 deletion .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,18 @@ After downloading the official weights, you can use the `load_model()` helper me
```python
from sam2 import load_model

model = load_model(variant="tiny", ckpt_path="artifacts/sam2_hiera_tiny.pt", device="cpu")
model = load_model(
variant="tiny",
ckpt_path="artifacts/sam2_hiera_tiny.pt",
device="cpu"
)
```

## Features 🚀

* CPU compatible
* ships with config files

## Citation

```bibtex
Expand Down
4 changes: 2 additions & 2 deletions sam2/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
# This source code is licensed under the license found in the
# LICENSE file in the root directory of this source tree.

from hydra import initialize_config_module
from hydra import initialize

from .build_sam import load_model

initialize_config_module("sam2.configs", version_base="1.2")
initialize("configs", version_base="1.2")

0 comments on commit 54d1866

Please sign in to comment.