Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/api/gam.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,13 @@ GAM model types from ``pymgcv.gam``.

::: pymgcv.gam.GAM
options:
inherited_members:
- __init__
heading_level: 2
inherited_members: __init__

::: pymgcv.gam.BAM
options:
heading_level: 2
inherited_members:
- __init__
inherited_members: __init__

::: pymgcv.gam.FitState
options:
Expand Down
24 changes: 14 additions & 10 deletions docs/api/plot.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# Plotting

`pymgcv.plot` provides plotting utilities for visualizing GAM models. Plotting is performed using matplotlib.
Across the package and examples, we use the import convention
```python
import pymgcv.plot as gplt
```

- For an overall plot of the partial effects of a gam model, use [`plot_gam`][pymgcv.plot.plot_gam].
- For an overall plot of the partial effects of a gam model, use [`plot`][pymgcv.plot.plot].
- For more fine control over the plotting, specific terms can be plotted onto a single matplotlib axis, using the functions:
* [`plot_continuous_1d`][pymgcv.plot.plot_continuous_1d]
* [`plot_continuous_2d`][pymgcv.plot.plot_continuous_2d]
* [`plot_categorical`][pymgcv.plot.plot_categorical]
* [`continuous_1d`][pymgcv.plot.continuous_1d]
* [`continuous_2d`][pymgcv.plot.continuous_2d]
* [`categorical`][pymgcv.plot.categorical]

::: pymgcv.plot.plot_gam
::: pymgcv.plot.plot_continuous_1d
::: pymgcv.plot.plot_continuous_2d
::: pymgcv.plot.plot_categorical
::: pymgcv.plot.plot_qq
::: pymgcv.plot.plot_residuals_vs_linear_predictor
::: pymgcv.plot.plot
::: pymgcv.plot.continuous_1d
::: pymgcv.plot.continuous_2d
::: pymgcv.plot.categorical
::: pymgcv.plot.qq
::: pymgcv.plot.residuals_vs_linear_predictor
::: pymgcv.plot.hexbin_residuals
294 changes: 104 additions & 190 deletions docs/examples/electricity_bam.ipynb

Large diffs are not rendered by default.

68 changes: 9 additions & 59 deletions docs/examples/gamlss.ipynb

Large diffs are not rendered by default.

40 changes: 10 additions & 30 deletions docs/examples/linear_functional.ipynb

Large diffs are not rendered by default.

110 changes: 19 additions & 91 deletions docs/examples/ozone.ipynb

Large diffs are not rendered by default.

40 changes: 6 additions & 34 deletions docs/examples/seasonal_co2.ipynb

Large diffs are not rendered by default.

53 changes: 9 additions & 44 deletions docs/examples/smooth_by_categorical.ipynb

Large diffs are not rendered by default.

161 changes: 49 additions & 112 deletions docs/examples/spatial_fish_eggs.ipynb

Large diffs are not rendered by default.

74 changes: 12 additions & 62 deletions docs/examples/supplement_vs_placebo.ipynb

Large diffs are not rendered by default.

31 changes: 5 additions & 26 deletions docs/index.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/scripts/notebooks.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
cd "$PIXI_PROJECT_ROOT"
find . -name "*.ipynb" -print0 | while IFS= read -r -d '' nb; do
jupyter nbconvert --to notebook --execute --inplace "$nb" --ExecutePreprocessor.kernel_name=pymgcv
jupyter nbconvert --to notebook --execute --inplace "$nb" --ExecutePreprocessor.kernel_name=pymgcv --ClearMetadataPreprocessor.enabled=True
done
2 changes: 1 addition & 1 deletion pymgcv/basis_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ class RandomEffect(AbstractBasis):
!!! example

For an example, see the
[supplement vs placebo example](../../examples/supplement_vs_placebo).
[supplement vs placebo example](../examples/supplement_vs_placebo.ipynb).

"""

Expand Down
Loading