Skip to content

Commit ba18648

Browse files
committed
[doc]: Update README.md to include an end-to-end tutorial and reorganize debug logging section for clarity
1 parent 94a75ef commit ba18648

1 file changed

Lines changed: 26 additions & 22 deletions

File tree

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,10 @@ bash ./scripts/run_tests.sh python
139139
```
140140
141141
## Usage
142+
### End-to-End Tutorial
143+
144+
You can find a tutorial showing simplified analysis steps for those we used in our paper in this [notebook](nbs/99-tutorials/05-walkthrough-with-gtex-data.ipynb) using the GTEx v8 data.
145+
142146

143147
### Basic Usage
144148

@@ -161,28 +165,6 @@ correlation = ccc(x, y)
161165
print(f"CCC coefficient: {correlation:.3f}")
162166
```
163167

164-
### Controlling Debug Logging
165-
166-
By default, CCC-GPU runs silently without debug output. You can enable detailed logging (including CUDA device information, memory usage, and processing details) using the `CCC_GPU_LOGGING` environment variable:
167-
168-
```bash
169-
# Run with default behavior (no debug output)
170-
python your_script.py
171-
172-
# Enable debug logging for troubleshooting
173-
CCC_GPU_LOGGING=1 python your_script.py
174-
175-
# Or set it for the session
176-
export CCC_GPU_LOGGING=1
177-
python your_script.py
178-
```
179-
180-
This is particularly useful for:
181-
- Debugging GPU memory issues
182-
- Understanding CUDA device utilization
183-
- Monitoring batch processing performance
184-
- Troubleshooting installation problems
185-
186168
### Working with Gene Expression Data
187169

188170
CCC-GPU is particularly useful for genomics applications:
@@ -220,6 +202,28 @@ for i, j in zip(top_indices[0], top_indices[1]):
220202

221203
Refer to the original CCC Repository for more usage examples: [https://github.com/greenelab/ccc](https://github.com/greenelab/ccc)
222204

205+
### Controlling Debug Logging
206+
207+
By default, CCC-GPU runs silently without debug output. You can enable detailed logging (including CUDA device information, memory usage, and processing details) using the `CCC_GPU_LOGGING` environment variable:
208+
209+
```bash
210+
# Run with default behavior (no debug output)
211+
python your_script.py
212+
213+
# Enable debug logging for troubleshooting
214+
CCC_GPU_LOGGING=1 python your_script.py
215+
216+
# Or set it for the session
217+
export CCC_GPU_LOGGING=1
218+
python your_script.py
219+
```
220+
221+
This is particularly useful for:
222+
- Debugging GPU memory issues
223+
- Understanding CUDA device utilization
224+
- Monitoring batch processing performance
225+
- Troubleshooting installation problems
226+
223227
## Performance Benchmarks
224228

225229
CCC-GPU provides significant performance improvements over CPU-only implementations:

0 commit comments

Comments
 (0)