Skip to content

Commit eb8c38b

Browse files
uriahfuriahf
authored
Merge pull request #85 from uriahf/observable_report
Observable report
2 parents cb33103 + 3cbab2b commit eb8c38b

File tree

131 files changed

+29807
-3059
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+29807
-3059
lines changed

‎.github/workflows/python-package.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ jobs:
4040
- name: Show package version
4141
run: grep -r "version" pyproject.toml || grep -r "__version__" rtichoke/ || python -c "import rtichoke; print(rtichoke.__version__)"
4242

43+
- name: Render and Publish
44+
working-directory: docs
45+
run: uv run quarto publish gh-pages --no-browser --token "${{ secrets.GITHUB_TOKEN }}"
46+
4347
- name: Publish package
4448
if: github.ref == 'refs/heads/main' && matrix.python-version == '3.10'
4549
run: uv publish

‎.gitignore‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,4 +140,18 @@ dmypy.json
140140

141141
# MacOS
142142
.DS_Store
143+
*.html
143144
docs/walkthrough_aj_estimate.html
145+
docs/_site/walkthrough_aj_estimate.html
146+
docs/_site/walkthrough_aj_estimate.html
147+
src/rtichoke/summary_report/summary_report_template.html
148+
docs/_site/walkthrough_aj_estimate.html
149+
docs/_site/walkthrough_aj_estimate.html
150+
docs/combined_adjusted_data.pkl
151+
docs/_site/walkthrough_aj_estimate.html
152+
probs_dict.pkl
153+
docs/_site/walkthrough_aj_estimate.html
154+
reals_dict.pkl
155+
times_dict.pkl
156+
docs/_site/example.html
157+
docs/_site/walkthrough_aj_estimate.html

‎.pre-commit-config.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
repos:
2+
- repo: https://github.com/astral-sh/ruff-pre-commit
3+
# Ruff version.
4+
rev: v0.11.13
5+
hooks:
6+
# Run the linter.
7+
- id: ruff-check
8+
# Run the formatter.
9+
- id: ruff-format
10+
- repo: https://github.com/astral-sh/uv-pre-commit
11+
# uv version.
12+
rev: 0.7.12
13+
hooks:
14+
# Update the uv lockfile
15+
- id: uv-lock

‎.readthedocs.yml‎

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

‎docs/_brand.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
color:
2+
palette:
3+
white: "#fff7f5"
4+
black: "#000000"
5+
navbar-bg: white # alias
6+
navbar-fg: "#c54b29"
7+
navbar-hl: "#c54b29"
8+
primary: "#FEF0EC"
9+
link: "#ce3d15"
10+
background: white
11+
foreground: black
12+
primary: primary
13+
light: white
14+
dark: black
15+
danger: navbar-fg
16+
link: link
17+
18+
typography:
19+
fonts:
20+
- family: Fraunces
21+
source: google
22+
weight: [400, 700]
23+
style: [normal, italic]
24+
- family: Commissioner
25+
source: google
26+
weight: [400, 600]
27+
style: [normal, italic]
28+
base:
29+
family: Commissioner
30+
size: 16px
31+
weight: 400
32+
line-height: 1.5
33+
headings:
34+
family: Fraunces
35+
weight: 700
36+
style: normal
37+
line-height: 1.2
38+
link:
39+
color: link
40+
weight: 600
41+
decoration: underline

‎docs/_quarto.yml‎

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,38 @@ metadata-files:
55
- _sidebar.yml
66

77
website:
8-
title: "My Documentation Site"
8+
title: "rtichoke"
99
navbar:
1010
left:
11-
- href: index.qmd
12-
text: Home
13-
- href: about.qmd
14-
text: About
11+
- href: reference.qmd
12+
text: Reference
1513
- href: walkthrough_aj_estimate.qmd
1614
text: Example
15+
- href: before_we_validate.qmd
16+
text: Before we Validate
1717

1818
quartodoc:
1919
# the name used to import the package you want to create reference docs for
2020
package: rtichoke
2121
sidebar: "_sidebar.yml"
2222
sections:
2323
- title: Calibration
24-
desc: Functions to inspect docstrings.
24+
desc: Functions for Calibration.
2525
contents:
2626
- create_calibration_curve
2727
- title: Discrimination
28-
desc: Functions to inspect docstrings.
28+
desc: Functions for Discrimination.
2929
contents:
30+
- create_roc_curve
31+
- create_precision_recall_curve
3032
- create_gains_curve
31-
- plot_precision_recall_curve
33+
- create_lift_curve
34+
- plot_roc_curve
35+
- plot_precision_recall_curve
36+
- plot_gains_curve
37+
- plot_lift_curve
38+
- title: Utility
39+
desc: Functions for Utility.
40+
contents:
41+
- create_decision_curve
42+
- plot_decision_curve

‎docs/_sidebar.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,18 @@ website:
66
- reference/create_calibration_curve.qmd
77
section: Calibration
88
- contents:
9+
- reference/create_roc_curve.qmd
10+
- reference/create_precision_recall_curve.qmd
911
- reference/create_gains_curve.qmd
12+
- reference/create_lift_curve.qmd
13+
- reference/plot_roc_curve.qmd
1014
- reference/plot_precision_recall_curve.qmd
15+
- reference/plot_gains_curve.qmd
16+
- reference/plot_lift_curve.qmd
1117
section: Discrimination
18+
- contents:
19+
- reference/create_decision_curve.qmd
20+
- reference/plot_decision_curve.qmd
21+
section: Utility
1222
id: reference
1323
- id: dummy-sidebar

0 commit comments

Comments
 (0)