Skip to content

Commit

Permalink
add tabpfn.show_versions() + issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
LeoGrin committed Feb 5, 2025
1 parent f1af310 commit cc7fdec
Show file tree
Hide file tree
Showing 4 changed files with 864 additions and 0 deletions.
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: Bug Report
description: Create a report to help us reproduce and correct the bug
labels: [bug]

body:
- type: markdown
attributes:
value: >
#### Before submitting a bug, please make sure the issue hasn't been already
addressed by searching through [the past issues](https://github.com/PriorLabs/TabPFN/issues).
- type: textarea
attributes:
label: Describe the bug
description: >
A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Steps/Code to Reproduce
description: |
Please add a minimal code example (some advices [here](https://scikit-learn.org/dev/developers/minimal_reproducer.html)) that can reproduce the error when running it. Be as succinct as possible, **do not depend on external data files**: instead you can generate synthetic data using `numpy.random`, [sklearn.datasets.make_regression](https://scikit-learn.org/stable/modules/generated/sklearn.datasets.make_regression.html), [sklearn.datasets.make_classification](https://scikit-learn.org/stable/modules/generated/sklearn.datasets.make_classification.html) or a few lines of Python code. Example:
```python
import numpy as np
from sklearn.datasets import make_classification
from tabpfn import TabPFNClassifier
# Generate synthetic classification data
X, y = make_classification(n_samples=100, n_features=10, random_state=42)
# Initialize and train TabPFN
classifier = TabPFNClassifier(N_estimators=4)
classifier.fit(X, y)
# Make predictions
y_pred = classifier.predict(X)
```
If the code is too long, feel free to put it in a public gist and link it in the issue: https://gist.github.com.
In short, **we are going to copy-paste your code** to run it and we expect to get the same result as you.
We acknowledge that crafting a minimal reproducible code example requires some effort on your side but it really helps the maintainers quickly reproduce the problem and analyze its cause without any ambiguity. Ambiguous bug reports tend to be slower to fix because they will require more effort and back and forth discussion between the maintainers and the reporter to pin-point the precise conditions necessary to reproduce the problem.
placeholder: |
```
Sample code to reproduce the problem
```
validations:
required: false
- type: textarea
attributes:
label: Expected Results
description: >
Please paste or describe the expected results.
placeholder: >
Example: No error is thrown.
validations:
required: false
- type: textarea
attributes:
label: Actual Results
description: |
Please paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full traceback** of the exception. For instance the code above raises the following exception:
```python-traceback
---------------------------------------------------------------------------
Traceback (most recent call last):
File "/Users/leo/VSCProjects/new/TabPFN/test_git.py", line 9, in <module>
classifier = TabPFNClassifier(N_estimators=4)
TypeError: TabPFNClassifier.__init__() got an unexpected keyword argument 'N_estimators'
```
placeholder: >
Please paste or specifically describe the actual output or traceback.
validations:
required: false
- type: textarea
attributes:
label: Versions
render: shell
description: |
Please run the following and paste the output below.
```python
import tabpfn; tabpfn.show_versions()
```
validations:
required: false
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/doc_improvement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Documentation improvement
description: Create a report to help us improve the documentation. Alternatively you can just open a pull request with the suggested change.
labels: [documentation]

body:
- type: textarea
attributes:
label: Describe the issue linked to the documentation
description: >
Tell us about the confusion introduced in the documentation.
validations:
required: true
- type: textarea
attributes:
label: Suggest a potential alternative/fix
description: >
Tell us how we could improve the documentation in this regard.
2 changes: 2 additions & 0 deletions src/tabpfn/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from importlib.metadata import version

from tabpfn.classifier import TabPFNClassifier
from tabpfn.debug_versions import show_versions
from tabpfn.regressor import TabPFNRegressor

try:
Expand All @@ -12,4 +13,5 @@
"TabPFNClassifier",
"TabPFNRegressor",
"__version__",
"show_versions",
]
Loading

0 comments on commit cc7fdec

Please sign in to comment.