Skip to content

Commit bdf98d2

Browse files
committed
docs:Better layout and explanations.
1 parent 9ac5a75 commit bdf98d2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ and the corresponding Markdown document
99

1010
------
1111

12-
## Summary of `Regressionizer` features
12+
## Features summary
1313

1414
- The class `Regressionizer` facilitates rapid specifications of regressions workflows.
1515
- To quickly specify:
@@ -21,6 +21,9 @@ and the corresponding Markdown document
2121

2222
- `Regressionizer` works with data frames, numpy arrays, lists of numbers, and lists of numeric pairs.
2323

24+
25+
### Details and arguments
26+
2427
- The curves computed with Quantile Regression are called **regression quantiles**.
2528

2629
- `Regressionizer` has three regression methods:
@@ -65,7 +68,7 @@ y = np.sin(2 * np.pi * x) + np.random.normal(0, 0.4, x.shape)
6568
data = np.column_stack((x, y)
6669
```
6770

68-
Compute quantile regression and make the corresponding plot:
71+
Compute quantile regression for probabilities `[0.2, 0.5, 0.8]` and make the corresponding plot:
6972

7073
```python
7174
obj = (Regressionizer(data)

0 commit comments

Comments
 (0)