abc

Author: noahho

.idea/PriorLabs.github.io.iml

@@ -0,0 +1,109 @@
+---
+title: API Usage Guide
+description: Complete guide for using the Prior Labs TabPFN API
+---
+
+# TabPFN API Guide
+
+## Authentication
+
+### Interactive Login
+
+The first time you use TabPFN, you'll be guided through an interactive login process:
+
+```python
+from tabpfn_client import init
+init()
+```
+
+### Managing Access Tokens
+
+You can save your token for use on other machines:
+
+```python
+import tabpfn_client
+# Get your token
+token = tabpfn_client.get_access_token()
+
+# Use token on another machine
+tabpfn_client.set_access_token(token)
+```
+
+## Rate Limits
+
+Our API implements a fair usage system that resets daily at 00:00:00 UTC.
+
+### Usage Cost Calculation
+
+The cost for each API request is calculated as:
+```python
+api_cost = (num_train_rows + num_test_rows) * num_cols * n_estimators
+```
+
+Where `n_estimators` is by default:
+- 4 for classification tasks
+- 8 for regression tasks
+
+### Monitoring Usage
+
+Track your API usage through response headers:
+
+| Header | Description |
+|--------|-------------|
+| `X-RateLimit-Limit` | Your total allowed usage |
+| `X-RateLimit-Remaining` | Remaining usage |
+| `X-RateLimit-Reset` | Reset timestamp (UTC) |
+
+## Current Limitations
+
+### Data Privacy and Security
+
+!!! warning "Important Data Guidelines"
+    - Do NOT upload any Personally Identifiable Information (PII)
+    - Do NOT upload any sensitive or confidential data
+    - Do NOT upload any data you don't have permission to share
+    - Consider anonymizing or pseudonymizing your data
+    - Review your organization's data sharing policies
+
+### Size Limitations
+
+1. Maximum total cells per request must be below 100,000:
+```python
+max_cells = (num_train_rows + num_test_rows) * num_cols
+```
+
+2. For regression with full output (`return_full_output=True`), the number of test samples must be below 500:
+```python
+if task == 'regression' and return_full_output and num_test_samples > 500:
+    raise ValueError("Cannot return full output for regression with >500 test samples")
+```
+
+These limits will be increased in future releases.
+
+### Managing User Data
+
+You can access and manage your personal information:
+
+```python
+from tabpfn_client import UserDataClient
+print(UserDataClient.get_data_summary())
+```
+
+## Error Handling
+
+The API uses standard HTTP status codes:
+
+| Code | Meaning |
+|------|----------|
+| 200 | Success |
+| 400 | Invalid request |
+| 429 | Rate limit exceeded |
+
+Example error response:
+```json
+{
+    "error": "API_LIMIT_REACHED",
+    "message": "Usage limit exceeded",
+    "next_available_at": "2024-01-07 00:00:00"
+}
+```

docs/getting_started/api.md

@@ -28,3 +28,7 @@ We will release open weights models soon, currently we are available via api and
 
     !!! warning
         Not released yet
+
+=== "Web Interface"
+
+    You can access our models through our Interface at [Prior Labs](https://www.ux.priorlabs.ai/).

docs/getting_started/install.md

@@ -228,28 +228,6 @@ runtime on GPU is typically less than 10 seconds.
 
 </div>
 
-## Installation
-
-<!---
-To install our software, we use pip the python package installer in combination with Git for code-management. An installation typically takes 5 minutes in a setup python environment. 
-!!! tip
-	
-	The easiest way to install and run our code is via the Colab Notebooks shared in the link in our submission.
--->
-You can access our models through our API (https://github.com/automl/tabpfn-client) or via our user interface built on top of the API (https://ux.priorlabs.ai/).
-We will release open weights models soon, currently we are available via api and via our user interface built on top of the API.
-=== "Python API Client (No GPU, Online)"
-
-    ```bash
-    pip install tabpfn-client
-    ```
-
-=== "Python Local (GPU)"
-
-    !!! warning
-        Not released yet
-
-
 <!---
 #### Software Dependencies and Operating Systems
 Python: Version >= 3.9