From a5889357753cec67aeb835745b6910a092654781 Mon Sep 17 00:00:00 2001 From: Nihit Date: Thu, 21 Mar 2024 12:40:34 -0700 Subject: [PATCH] Document custom init params (#31) --- docs/python-sdk.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/python-sdk.md b/docs/python-sdk.md index bd82504..946e82e 100644 --- a/docs/python-sdk.md +++ b/docs/python-sdk.md @@ -48,6 +48,15 @@ options = { refuel_client = refuel.init(**options) ``` +Here’s the complete list of initialization options currently supported: +| Option | Is Required | Default Value | Comments | +| :------------- | :-----------| :-------------| :------- | +| `api_key` | Yes | None | Used to authenticate all requests to the API server | +| `project` | Yes | None | The name of the project you plan to use for the current session. This is analogous to setting the project from the top-level dropdown in the app.refuel.ai | +| `timeout` | No | 60 | Timeout in seconds | +| `max_retries` | No | 3 | Max number of retries for failed requests | +| `max_workers` | No | Num CPUs (os.cpu_count()) | Max number of concurrent requests to the API server | + ## Projects @@ -302,6 +311,7 @@ items_filter = { items = refuel_client.get_dataset_items( dataset='', + task='' max_items=10, filters = [items_filter] )