Skip to content

Commit 79c1e03

Browse files
noahhonoahho
authored andcommitted
- updated docs
1 parent 5687789 commit 79c1e03

File tree

211 files changed

+6067
-236922
lines changed

Some content is hidden

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

211 files changed

+6067
-236922
lines changed

docs/getting_started/install.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
**Client** [![colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1KKKOVJk-5N972ZRUeGmRXh8EibRIRGxA#scrollTo=o03aOVAw0Etg)
2-
**Local** [![colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1SHa43VuHASLjevzO7y3-wPCxHY18-2H6#scrollTo=o03aOVAw0Etg&line=3&uniqifier=1)
3-
41
You can access our models through our API (https://github.com/automl/tabpfn-client), via our user interface built on top of the API (https://www.ux.priorlabs.ai/) or locally.
52

63
=== "Python API Client (No GPU, Online)"

docs/getting_started/intended_use.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Usage tips
22

3-
!!! note
4-
For a simple example getting started with classification see [classification tutorial](../tutorials/classification.md).
5-
6-
We provide two comprehensive demo notebooks that guides through installation and functionalities. One [colab tutorial using the cloud](https://tinyurl.com/tabpfn-colab-online) and one [colab tutorial using the local GPU](https://tinyurl.com/tabpfn-colab-local).
3+
> [!TIP]
4+
>
5+
> Dive right in with our interactive Colab notebook! It's the best way to get a hands-on feel for TabPFN, walking you through installation, classification, and regression examples.
6+
>
7+
> [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/PriorLabs/TabPFN/blob/main/examples/notebooks/TabPFN_Demo_Local.ipynb)
78
89
### When to use TabPFN
910

docs/research/papers.md

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

mkdocs.yml

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -62,39 +62,41 @@ extra:
6262
plugins:
6363
- search
6464
- autorefs
65-
- gen-files:
66-
scripts:
67-
- scripts/gen_ref_pages.py
65+
# - gen-files:
66+
# scripts:
67+
# - scripts/gen_ref_pages.py
6868
- literate-nav:
6969
nav_file: SUMMARY.md
70-
- mkdocstrings:
71-
default_handler: python
72-
handlers:
73-
python:
74-
paths: ["src/tabpfn/src/", "src/tabpfn-client/", "src/tabpfn-extensions/src/"]
75-
rendering:
76-
merge_init_into_class: true
77-
docstring_style: "google"
78-
options:
79-
filters: ["!^_"]
80-
heading_level: 1
81-
line_length: 60
82-
inherited_members: true
83-
separate_signature: true
84-
show_root_heading: true
85-
show_root_full_path: false
86-
show_signature_annotations: true
87-
signature_crossrefs: true
88-
summary: true
89-
show_signature: true
90-
show_source: False
70+
# - mkdocstrings:
71+
# default_handler: python
72+
# handlers:
73+
# python:
74+
# paths: ["src/tabpfn/src/", "src/tabpfn-client/", "src/tabpfn-extensions/src/"]
75+
# rendering:
76+
# merge_init_into_class: true
77+
# docstring_style: "google"
78+
# options:
79+
# filters: ["!^_"]
80+
# heading_level: 1
81+
# line_length: 60
82+
# inherited_members: true
83+
# separate_signature: true
84+
# show_root_heading: true
85+
# show_root_full_path: false
86+
# show_signature_annotations: true
87+
# signature_crossrefs: true
88+
# summary: true
89+
# show_signature: true
90+
# show_source: False
9191

9292
extra_css:
9393
- stylesheets/extra.css
9494

9595
nav:
9696
- Home: index.md # Includes link to
9797
- Getting Started:
98+
# web link
99+
- Colab Notebook (Recommended): https://colab.research.google.com/github/PriorLabs/TabPFN/blob/main/examples/notebooks/TabPFN_Demo_Local.ipynb
98100
- Installation: getting_started/install.md
99101
- Intended Use: getting_started/intended_use.md
100102
- API Usage Guide: getting_started/api.md
@@ -115,13 +117,13 @@ nav:
115117
# - Agenda: agenda.md
116118
#- Team:
117119
# Demo
118-
- Code Reference: reference/
120+
# - Code Reference: reference/
119121
# Extensions
120122
markdown_extensions:
121123
- attr_list
122124
- pymdownx.emoji:
123-
emoji_index: !!python/name:material.extensions.emoji.twemoji
124-
emoji_generator: !!python/name:material.extensions.emoji.to_svg
125+
emoji_index: !!python/name:material.extensions.emoji.twemoji # New path
126+
emoji_generator: !!python/name:material.extensions.emoji.to_svg # New path
125127
- markdown.extensions.admonition
126128
- markdown.extensions.attr_list
127129
- markdown.extensions.codehilite:

pyproject.toml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[build-system]
2+
requires = ["setuptools", "wheel"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "PriorLabs.GitHub.MkDocs"
7+
version = "2.1.1"
8+
dependencies = [
9+
"mkdocs>=1.5.3,<2",
10+
# mkdocs-material is a popular theme for MkDocs
11+
"mkdocs-material>=9.0.0",
12+
# auto refs
13+
"mkdocs-autorefs>=0.3.0",
14+
# gen-files
15+
"mkdocs-gen-files>=0.4.0",
16+
# literate navs
17+
"mkdocs-literate-nav>=0.2.0",
18+
# mkdoc strings [python]
19+
"mkdocstrings[python]>=0.20.0",
20+
]
21+
requires-python = ">=3.9"

site/404.html

Lines changed: 731 additions & 1 deletion
Large diffs are not rendered by default.

site/_next/static/SKTlJgQzBDb4uAEdtF2Zq/_buildManifest.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

site/_next/static/SKTlJgQzBDb4uAEdtF2Zq/_ssgManifest.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

site/_next/static/chunks/219-7f18aac596925ef1.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

site/_next/static/chunks/30a37ab2-b2120806d300c7b3.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)