fix(ci): Remove GitHub dependencies (#14)

* fix(ci): Remove GitHub dependencies * fix(ci): Remove GitHub dependencies from pyproject.toml * feat(back): Rename segment_anything module to github * chore: Update CHANGELOG.md
pixano · Feb 29, 2024 · a295fb9 · a295fb9
1 parent 18ff935
commit a295fb9
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 8 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -41,13 +41,16 @@ jobs:
           python-version: "3.10"
 
       # Install PyTorch and TensorFlow CPU versions manually to prevent installing CUDA
+      # Install SAM and MobileSAM manually as they cannot be included in PyPI
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install pylint
           python -m pip install torch~=2.2.0 torchaudio~=2.2.0 torchvision~=0.17.0 --index-url https://download.pytorch.org/whl/cpu
           python -m pip install tensorflow-cpu~=2.15.0
-          python -m pip install .[sam]
+          python -m pip install segment-anything@git+https://github.com/facebookresearch/segment-anything
+          python -m pip install mobile-sam@git+https://github.com/ChaoningZhang/MobileSAM
+          python -m pip install .
 
       - name: Lint backend code with Pylint
         run: |

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,8 +17,7 @@ All notable changes to Pixano will be documented in this file.
 
 ### Changed
 
-- **Breaking:** Make SAM and MobileSAM optional dependencies to allow publishing to PyPI
-  - Install those dependencies with `pip install pixano-inference[sam]`
+- **Breaking:** Remove SAM and MobileSAM dependencies to allow publishing to PyPI
 - **Breaking:** Update to Pixano 0.5.0
 - **Breaking:** Update InferenceModel `id` attribute to `model_id` to stop redefining built-in `id`
 - **Breaking:** Update submodule names to `pytorch` and `tensorflow`

diff --git a/docs/api_reference/index.md b/docs/api_reference/index.md
@@ -3,6 +3,6 @@
 Here you will find the documentation for all of our implemented models.
 
 - The **_pytorch_** module contains models from the PyTorch library.
-- The **_segment_anything_** module contains the Segment Anything Model (SAM) for Meta.
+- The **_github_** module contains the Segment Anything Model (SAM) for Meta.
 - The **_tensorflow_** module contains models from the TensorFlow library.
 - The **_transformers_** module contains models from the Hugging Face Transformers library.
diff --git a/docs/getting_started/installing_pixano_inference.md b/docs/getting_started/installing_pixano_inference.md
@@ -13,3 +13,10 @@ Then, you can install the Pixano and Pixano Inference packages inside that envir
 pip install pixano
 pip install pixano-inference
 ```
+
+To use the inference models available through GitHub, install the following additional packages:
+
+```shell
+python -m pip install segment-anything@git+https://github.com/facebookresearch/segment-anything
+python -m pip install mobile-sam@git+https://github.com/ChaoningZhang/MobileSAM
+```
diff --git a/...no_inference/segment_anything/__init__.py → pixano_inference/github/__init__.py b/...no_inference/segment_anything/__init__.py → pixano_inference/github/__init__.py
diff --git a/..._inference/segment_anything/mobile_sam.py → pixano_inference/github/mobile_sam.py b/..._inference/segment_anything/mobile_sam.py → pixano_inference/github/mobile_sam.py
diff --git a/pixano_inference/segment_anything/sam.py → pixano_inference/github/sam.py b/pixano_inference/segment_anything/sam.py → pixano_inference/github/sam.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -49,10 +49,6 @@ documentation = [
   "mkdocs-literate-nav ~= 0.6.0",
   "mkdocs-redirects ~= 1.2.1",
 ]
-sam = [
-  "segment-anything@git+https://github.com/facebookresearch/segment-anything",
-  "mobile-sam@git+https://github.com/ChaoningZhang/MobileSAM",
-]
 
 [project.urls]
 Documentation = "https://github.com/pixano/pixano-inference#readme"