|
2 | 2 |
|
3 | 3 | [](https://results.pre-commit.ci/latest/github/EliHei2/segger_dev/main) |
4 | 4 |
|
5 | | -**Important note (Dec 2024)**: As segger is currently undergoing constant development we highly recommending installing segger directly via github. |
| 5 | +**Important note (Dec 2024)**: As segger is currently undergoing constant development, we highly recommend installing it directly via GitHub. |
6 | 6 |
|
7 | 7 | **segger** is a cutting-edge tool for **cell segmentation** in **single-molecule spatial omics** datasets. By leveraging **graph neural networks (GNNs)** and heterogeneous graphs, segger offers unmatched accuracy and scalability. |
8 | 8 |
|
@@ -51,67 +51,33 @@ segger tackles these with a **graph-based approach**, achieving superior segment |
51 | 51 |
|
52 | 52 | ## Installation |
53 | 53 |
|
54 | | -**Important note (Dec 2024)**: As segger is currently undergoing constant development we highly recommending installing segger directly via github. |
55 | | - |
56 | | -### Important: PyTorch Geometric Dependencies |
57 | | - |
58 | | -Segger **relies heavily** on PyTorch Geometric for its graph-based operations. One **must** install its dependencies (such as `torch-sparse` and `torch-scatter`) based on their system’s specifications, especially the **CUDA** and **PyTorch** versions. |
59 | | - |
60 | | -Please follow the official [PyTorch Geometric Installation Guide](https://pytorch-geometric.readthedocs.io/en/latest/install/installation.html) to install the correct versions of `torch-sparse`, `torch-scatter`, and other relevant libraries. |
61 | | - |
62 | | -Below is a quick guide for installing PyTorch Geometric dependencies for **torch 2.4.0**: |
63 | | - |
64 | | -#### For CUDA 11.x: |
65 | | - |
66 | | -```bash |
67 | | -pip install pyg_lib torch_scatter torch_sparse torch_cluster torch_spline_conv -f https://data.pyg.org/whl/torch-2.4.0+cu121.html |
68 | | -``` |
69 | | - |
70 | | -#### For CUDA 12.x: |
71 | | - |
72 | | -```bash |
73 | | -pip install pyg_lib torch_scatter torch_sparse torch_cluster torch_spline_conv -f https://data.pyg.org/whl/torch-2.4.0+cu118.html |
74 | | -``` |
75 | | - |
76 | | -Afterwards choose the installation method that best suits your needs. |
| 54 | +**Important note (Dec 2024)**: As segger is currently undergoing constant development, we highly recommend installing it directly via GitHub. |
77 | 55 |
|
78 | 56 | ### GitHub Installation |
79 | 57 |
|
80 | 58 | For a straightforward local installation from GitHub, clone the repository and install the package using `pip`: |
81 | 59 |
|
82 | | -#### Pip Installation (RAPIDS and CUDA 11) |
83 | | - |
84 | | -For installations requiring RAPIDS and CUDA 11 support, run: |
85 | | - |
86 | 60 | ```bash |
87 | | -pip install -e ".[rapids11]" |
| 61 | +git clone https://github.com/EliHei2/segger_dev.git |
| 62 | +cd segger_dev |
| 63 | +pip install -e ".[cuda12]" |
88 | 64 | ``` |
89 | 65 |
|
90 | | -#### Pip Installation (RAPIDS and CUDA 12) |
91 | | - |
92 | | -For installations requiring RAPIDS and CUDA 12 support, run: |
93 | | - |
94 | | -```bash |
95 | | -pip install -e ".[rapids12]" |
96 | | -``` |
| 66 | +segger requires **CUDA 11** or **CUDA 12** for GPU acceleration. |
| 67 | +You can find more detailed information in our **[Installation Guide](https://elihei2.github.io/segger_dev/installation/)**. |
| 68 | +To avoid dependency conflicts, we recommend installing segger in a virtual environment or using a containerized environment. |
97 | 69 |
|
98 | 70 | ### Docker Installation |
99 | 71 |
|
100 | | -Segger provides an easy-to-use Docker container for those who prefer a containerized environment. To pull the latest Docker image: |
| 72 | +We provide an easy-to-use Docker container for those who prefer a containerized environment. To pull and run the Docker image: |
101 | 73 |
|
102 | 74 | ```bash |
103 | | -docker pull danielunyi42/segger_dev:latest |
| 75 | +docker pull danielunyi42/segger_dev:cuda121 |
| 76 | +docker run --gpus all -it danielunyi42/segger_dev:cuda121 |
104 | 77 | ``` |
105 | 78 |
|
106 | | -The Docker image comes with all dependencies packaged, including RAPIDS. It currently supports only CUDA 12.2, and we will soon release a version that supports CUDA 11.8. |
107 | | - |
108 | | -### Singularity Installation |
109 | | - |
110 | | -For users who prefer Singularity, you can pull the Docker image as follows: |
111 | | - |
112 | | -```bash |
113 | | -singularity pull docker://danielunyi42/segger_dev:latest |
114 | | -``` |
| 79 | +The official Docker image comes with all dependencies pre-installed, including the CUDA toolkit, PyTorch, and CuPy. |
| 80 | +The current images support **CUDA 11.8** and **CUDA 12.1**, which can be specified in the image tag. |
115 | 81 |
|
116 | 82 | --- |
117 | 83 |
|
|
0 commit comments