Skip to content

Commit cc71426

Browse files
committed
plan proposition for the user guide
1 parent 7d33d14 commit cc71426

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

docs/algorithms.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
- Data format and preprocessing steps.
66
### Running Task
77
- How to run the fit algorithm.
8-
- Example commands and code snippets.
8+
- Example commands and code snippets.
99
### Output
1010
- What results to expect from the fitting process.
1111
- DataFrame object
1212
- Plotting object
13+
<<<<<<< HEAD
1314
### Setting Options (Different Models)
1415
- How to set specific options for different types of models.
1516
- Customizing parameters for logistic, joint, mixture, and covariate models.
@@ -165,9 +166,37 @@ Refer to the docstring for further details.
165166
- not enough patients
166167
- parameters don't converge
167168
- score don't progress
169+
<<<<<<< HEAD
168170

169171
## References
170172

171173
```{bibliography}
172174
:filter: docname in docnames
173-
```
175+
```
176+
=======
177+
=======
178+
### Diagnosis
179+
- parameters don't converge
180+
- Send to metrics section?
181+
### Setting Options (Different Models)
182+
- How to set specific options for different types of models.
183+
- Customizing parameters for logistic, joint, mixture, and covariate models.
184+
185+
## Personalize
186+
### Prerequisites
187+
### Running Task
188+
### Output
189+
### Diagnosis
190+
191+
### Setting Options (Different Models)
192+
## Estimate
193+
### Prerequisites
194+
### Running Task
195+
### Output
196+
### Diagnosis
197+
198+
## Simulate
199+
### Prerequisites
200+
### Running Task
201+
### Output
202+
### Diagnosis

docs/to_go_further.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ __Make predictions:__ Leaspy outperformed the 56 alternative methods for predict
2828

2929
```{bibliography}
3030
:filter: docname in docnames
31-
```
31+
```

0 commit comments

Comments
 (0)