updated docs

unifyai · Jan 22, 2025 · 4acd4f3 · 4acd4f3
1 parent 8388e4e
commit 4acd4f3
Show file tree

Hide file tree

Showing 84 changed files with 469 additions and 469 deletions.
diff --git a/api-reference/llm_queries/chat_completions.mdx b/api-reference/llm_queries/chat_completions.mdx
@@ -194,8 +194,8 @@ curl --request POST \
     "response_format": "{ \"type\": \"json_mode\"}",
     "seed": 11,
     "stream_options": [
-        true,
-        "include_usage"
+        "include_usage",
+        true
     ],
     "top_p": 0.5,
     "tool_choice": "{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}",
@@ -218,7 +218,7 @@ url = "https://api.unify.ai/v0/chat/completions"
 
 headers = {"Authorization": "Bearer <token>"}
 
-json_input = {"messages": [{"content": "Tell me a joke", "role": "user"}], "model": "gpt-4o-mini@openai", "max_tokens": 1024, "stop": ["The End.", " is the answer."], "stream": False, "temperature": 0.9, "frequency_penalty": 1.5, "logit_bias": {"0": 10, "1": -75, "2": 90}, "logprobs": False, "top_logprobs": 15, "n": 15, "presence_penalty": -1.1, "response_format": "{ "type": "json_mode"}", "seed": 11, "stream_options": [True, "include_usage"], "top_p": 0.5, "tool_choice": "{"type": "function", "function": {"name": "my_function"}}", "parallel_tool_calls": True, "user": "some_user", "signature": "python", "use_custom_keys": True, "tags": ["user123", "CompanyABC"], "drop_params": True}
+json_input = {"messages": [{"content": "Tell me a joke", "role": "user"}], "model": "gpt-4o-mini@openai", "max_tokens": 1024, "stop": ["The End.", " is the answer."], "stream": False, "temperature": 0.9, "frequency_penalty": 1.5, "logit_bias": {"0": 10, "1": -75, "2": 90}, "logprobs": False, "top_logprobs": 15, "n": 15, "presence_penalty": -1.1, "response_format": "{ "type": "json_mode"}", "seed": 11, "stream_options": ["include_usage", True], "top_p": 0.5, "tool_choice": "{"type": "function", "function": {"name": "my_function"}}", "parallel_tool_calls": True, "user": "some_user", "signature": "python", "use_custom_keys": True, "tags": ["user123", "CompanyABC"], "drop_params": True}
 
 response = requests.request("POST", url, json=json_input, headers=headers)
 

diff --git a/api-reference/openapi.json b/api-reference/openapi.json
@@ -4768,8 +4768,8 @@
                         "title": "Stream Options",
                         "description": "Options for streaming response. Only set this when you set `stream: true`.",
                         "example": [
-                            true,
-                            "include_usage"
+                            "include_usage",
+                            true
                         ]
                     },
                     "top_p": {

diff --git a/python/classes/interfaces/dataset/Dataset.mdx b/python/classes/interfaces/dataset/Dataset.mdx
@@ -6,13 +6,13 @@ title: 'Dataset'
 class Dataset
 ```
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L14)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L14)</p>
 
 
 
 ### \_\_init\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L16)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L16)</p>
 
 ```python
 def __init__(
@@ -48,7 +48,7 @@ Initialize a local dataset.
 
 ### name
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L63)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L63)</p>
 
 ```python
 def name(self) -> str:
@@ -62,7 +62,7 @@ Name of the dataset.
 
 ### set\_name
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L80)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L80)</p>
 
 ```python
 def set_name(self, name: str) -> Self:
@@ -86,7 +86,7 @@ This dataset, useful for chaining methods.
 
 ### add
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L253)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L253)</p>
 
 ```python
 def add(
@@ -119,7 +119,7 @@ The new dataset following the addition.
 
 ### download
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L177)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L177)</p>
 
 ```python
 def download(self, overwrite: bool = False) -> Self:
@@ -144,7 +144,7 @@ This dataset after the in-place download, useful for chaining methods.
 
 ### from\_upstream
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L93)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L93)</p>
 
 ```python
 def from_upstream(
@@ -176,7 +176,7 @@ The dataset, with contents downloaded from upstream.
 
 ### inplace\_add
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L302)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L302)</p>
 
 ```python
 def inplace_add(
@@ -209,7 +209,7 @@ This dataset following the in-place addition.
 
 ### inplace\_sub
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L331)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L331)</p>
 
 ```python
 def inplace_sub(
@@ -235,7 +235,7 @@ This dataset following the in-place subtraction.
 
 ### sub
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L280)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L280)</p>
 
 ```python
 def sub(
@@ -261,7 +261,7 @@ The new dataset following the subtraction.
 
 ### sync
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L213)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L213)</p>
 
 ```python
 def sync(self) -> Self:
@@ -278,7 +278,7 @@ This dataset after the in-place sync, useful for chaining methods.
 
 ### upload
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L132)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L132)</p>
 
 ```python
 def upload(self, overwrite: bool = False) -> Self:
@@ -303,7 +303,7 @@ This dataset, useful for chaining methods.
 
 ### upstream\_diff
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L225)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L225)</p>
 
 ```python
 def upstream_diff(self) -> Self:
@@ -321,7 +321,7 @@ This dataset after printing the diff, useful for chaining methods.
 
 ### \_\_add\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L355)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L355)</p>
 
 ```python
 def __add__(
@@ -348,7 +348,7 @@ The new dataset following the addition.
 
 ### \_\_contains\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L476)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L476)</p>
 
 ```python
 def __contains__(
@@ -375,7 +375,7 @@ Boolean, whether the passed Dataset is a subset of this one.
 
 ### \_\_getitem\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L506)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L506)</p>
 
 ```python
 def __getitem__(self, item: Union[int, slice]) -> Union[Any, Dataset]:
@@ -399,7 +399,7 @@ An individual item or Dataset slice, for int and slice queries respectively.
 
 ### \_\_iadd\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L399)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L399)</p>
 
 ```python
 def __iadd__(
@@ -425,7 +425,7 @@ This dataset following the in-place addition.
 
 ### \_\_isub\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L450)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L450)</p>
 
 ```python
 def __isub__(
@@ -451,7 +451,7 @@ This dataset following the in-place subtraction.
 
 ### \_\_iter\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L466)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L466)</p>
 
 ```python
 def __iter__(self) -> Any:
@@ -467,7 +467,7 @@ The next instance in the dataset.
 
 ### \_\_len\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L497)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L497)</p>
 
 ```python
 def __len__(self) -> int:
@@ -483,7 +483,7 @@ The number of entries in the dataset.
 
 ### \_\_radd\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L372)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L372)</p>
 
 ```python
 def __radd__(
@@ -518,7 +518,7 @@ The new dataset following the addition.
 
 ### \_\_rsub\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L432)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L432)</p>
 
 ```python
 def __rsub__(
@@ -546,7 +546,7 @@ The new dataset following the subtraction.
 
 ### \_\_sub\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/dataset.py#L415)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/dataset.py#L415)</p>
 
 ```python
 def __sub__(

diff --git a/python/classes/interfaces/logs/Context.mdx b/python/classes/interfaces/logs/Context.mdx
@@ -6,13 +6,13 @@ title: 'Context'
 class Context
 ```
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L139)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L139)</p>
 
 
 
 ### \_\_init\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L141)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L141)</p>
 
 ```python
 def __init__(self, context: str):
@@ -26,7 +26,7 @@ def __init__(self, context: str):
 
 ### \_\_enter\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L144)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L144)</p>
 
 ```python
 def __enter__(self):
@@ -38,7 +38,7 @@ def __enter__(self):
 
 ### \_\_exit\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L149)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L149)</p>
 
 ```python
 def __exit__(self, *args, **kwargs):

diff --git a/python/classes/interfaces/logs/Entries.mdx b/python/classes/interfaces/logs/Entries.mdx
@@ -6,13 +6,13 @@ title: 'Entries'
 class Entries
 ```
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L153)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L153)</p>
 
 
 
 ### \_\_init\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L155)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L155)</p>
 
 ```python
 def __init__(self, **entries):
@@ -26,7 +26,7 @@ def __init__(self, **entries):
 
 ### \_\_enter\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L158)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L158)</p>
 
 ```python
 def __enter__(self):
@@ -38,7 +38,7 @@ def __enter__(self):
 
 ### \_\_exit\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L166)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L166)</p>
 
 ```python
 def __exit__(self, *args, **kwargs):

diff --git a/python/classes/interfaces/logs/Experiment.mdx b/python/classes/interfaces/logs/Experiment.mdx
@@ -6,13 +6,13 @@ title: 'Experiment'
 class Experiment
 ```
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L193)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L193)</p>
 
 
 
 ### \_\_init\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L195)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L195)</p>
 
 ```python
 def __init__(self, name: str):
@@ -26,7 +26,7 @@ def __init__(self, name: str):
 
 ### \_\_enter\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L198)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L198)</p>
 
 ```python
 def __enter__(self):
@@ -38,7 +38,7 @@ def __enter__(self):
 
 ### \_\_exit\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/edd6a8664e1bdfade4f63f66561df418306e80c4/unify/interfaces/logs.py#L206)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/2265dc82d30d55eb1b81a2f0a76023234dc8b424/unify/interfaces/logs.py#L206)</p>
 
 ```python
 def __exit__(self, *args, **kwargs):