Skip to content

Commit 46db368

Browse files
Remove ReadTheDocs configuration and update documentation for clarity and consistency
1 parent b424e3e commit 46db368

8 files changed

Lines changed: 80 additions & 79 deletions

File tree

.readthedocs.yml

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/cli_steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ What the installer does (high-level):
4444

4545
```bash
4646
source braingraph_pipeline/bin/activate
47-
python scripts/validate_setup.py --config configs/braingraph_default_config.json
47+
python scripts/validate_setup.py --config configs/ braingraph_default_config.json
4848
```
4949

5050
---

docs/methods.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This method serves as a rigorous baseline and validation tool.
2424

2525
### Design
2626
- **Split-Half Validation**: The cohort is split into two "waves" (Wave 1 and Wave 2).
27-
- **Exhaustive Search**: A grid of parameters is defined (e.g., FA $\in \{0.1, 0.2\}$, Angle $\in \{30, 60\}$).
27+
- **Exhaustive Search**: A grid of parameters is defined (e.g., FA $\in \\{0.1, 0.2\\}$, Angle $\in \\{30, 60\\}$).
2828
- **Evaluation**: Every combination is run on both waves.
2929
- **Selection**: We select parameters that:
3030
1. Score highly in Wave 1.
@@ -37,7 +37,12 @@ This method is computationally expensive ($O(N^k)$ where $k$ is the number of pa
3737

3838
The objective function maximizes a composite score derived from graph-theoretic metrics:
3939

40-
$$ Score = w_1 \cdot Density_{score} + w_2 \cdot Efficiency_{score} + w_3 \cdot SmallWorld_{score} ... $$
40+
$$
41+
\mathrm{Score} =
42+
w_1 \cdot \mathrm{Density}_{\mathrm{score}} +
43+
w_2 \cdot \mathrm{Efficiency}_{\mathrm{score}} +
44+
w_3 \cdot \mathrm{SmallWorld}_{\mathrm{score}} + \cdots
45+
$$
4146

4247
- **Density**: Penalizes unconnected or fully connected graphs.
4348
- **Global Efficiency**: Measures integration.

docs/rt_d_integration.md

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
/*
2+
Disable colored syntax highlighting in code blocks.
3+
Works with/without Pygments or other highlighters.
4+
*/
5+
6+
pre code,
7+
.codehilite,
8+
.codehilite pre,
9+
.highlight,
10+
.highlight pre {
11+
color: inherit;
12+
}
13+
14+
.codehilite span,
15+
.highlight span {
16+
color: inherit !important;
17+
background: none !important;
18+
font-weight: inherit !important;
19+
font-style: inherit !important;
20+
}

docs/workflows.md

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,55 @@ All OptiConn workflows follow the same core pattern: **parameter space explorati
44

55
## Bayesian optimization → Apply (recommended)
66
1. Find optimal parameters on a pilot subset:
7-
```bash
8-
python opticonn.py tune-bayes \
9-
-i /path/to/pilot_data \
10-
-o studies/bayes_opt \
11-
--config configs/braingraph_default_config.json \
12-
--modalities qa \
13-
--n-iterations 30 \
14-
--sample-subjects
15-
```
7+
8+
```console
9+
python opticonn.py tune-bayes \
10+
-i /path/to/pilot_data \
11+
-o studies/bayes_opt \
12+
--config configsbraingraph_default_config.json \
13+
--modalities qa \
14+
--n-iterations 30 \
15+
--sample-subjects
16+
```
1617
2. Inspect selection:
17-
```bash
18-
python opticonn.py select -i studies/bayes_opt --modality qa
19-
```
18+
19+
```console
20+
python opticonn.py select -i studies/bayes_opt --modality qa
21+
```
22+
2023
3. Apply to the full dataset:
21-
```bash
22-
python opticonn.py apply \
23-
-i /path/to/full_dataset \
24-
--optimal-config studies/bayes_opt/qa/bayesian_optimization_results.json \
25-
-o studies/final_analysis
26-
```
24+
25+
```console
26+
python opticonn.py apply \
27+
-i /path/to/full_dataset \
28+
--optimal-config studies/bayes_oqa/bayesian_optimization_results.json \
29+
-o studies/final_analysis
30+
```
2731

2832
## Cross-validation bootstrap (with Bayes seeding)
2933
1. Run Bayesian optimization (small pilot) as above.
3034
2. Seed cross-validation with the Bayes result:
31-
```bash
32-
python scripts/cross_validation_bootstrap_optimizer.py \
33-
-i /path/to/pilot_data \
34-
-o studies/cv \
35-
--extraction-config configs/demo_config.json \
36-
--from-bayes studies/bayes_opt/qa/bayesian_optimization_results.json \
37-
--subjects 3 \
38-
--max-parallel 1 \
39-
--verbose
40-
```
41-
- Uses two waves by default; metrics/atlases stay fixed from the base config.
42-
- Seeded parameters come from `best_parameters` in the Bayes results.
35+
36+
```sh
37+
python scriptcross_validation_bootstrap_optimizepy \
38+
-i /path/to/pilot_data \
39+
-o studies/cv \
40+
--extraction-config configdemo_config.json \
41+
--from-bayes studies/bayes_optqbayesian_optimization_results.json \
42+
--subjects 3 \
43+
--max-parallel 1 \
44+
--verbose
45+
```
46+
47+
- Uses two waves by default; metrics/atlases stay fixed from the base config.
48+
- Seeded parameters come from `best_parameters` in the Bayes results.
4349

4450
## Apply-only with known optimal config
45-
```bash
51+
52+
```sh
4653
python opticonn.py apply \
47-
-i /path/to/full_dataset \
48-
--optimal-config studies/bayes_opt/qa/bayesian_optimization_results.json \
49-
-o studies/final_analysis
54+
-i /path/to/full_dataset \
55+
--optimal-config studies/bayes_opt/qa/ \ bayesian_optimization_results.json \
56+
-o studies/final_analysis
5057
```
58+

mkdocs.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ nav:
1111
- Workflows: workflows.md
1212
- CLI & Steps: cli_steps.md
1313
- Demos: demos.md
14-
- RTD Integration: rt_d_integration.md
1514
- Configuration: configuration.md
1615
- Validation Notes: validation.md
1716
- User Guide: user_guide.md
@@ -21,7 +20,15 @@ theme:
2120
name: readthedocs
2221
markdown_extensions:
2322
- admonition
24-
- codehilite
23+
- fenced_code
24+
- pymdownx.arithmatex:
25+
generic: true
2526
- toc:
2627
permalink: true
2728
- tables
29+
30+
extra_css:
31+
- stylesheets/no_code_colors.css
32+
33+
extra_javascript:
34+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

scripts/test/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Test package for OptiConn scripts

0 commit comments

Comments
 (0)