updated docs

unifyai · Nov 8, 2024 · 5c920a7 · 5c920a7
1 parent 77ac021
commit 5c920a7
Show file tree

Hide file tree

Showing 82 changed files with 480 additions and 480 deletions.
diff --git a/python/classes/evals/dataset/Dataset.mdx b/python/classes/evals/dataset/Dataset.mdx
@@ -6,7 +6,7 @@ title: 'Dataset'
 class Dataset
 ```
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L14)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L14)</p>
 
 
 
@@ -16,7 +16,7 @@ class Dataset
 
 ### name
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L61)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L61)</p>
 
 ```python
 def name(self) -> str:
@@ -30,7 +30,7 @@ Name of the dataset.
 
 ### set\_name
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L78)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L78)</p>
 
 ```python
 def set_name(self, name: str) -> Self:
@@ -54,7 +54,7 @@ This dataset, useful for chaining methods.
 
 ### add
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L251)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L251)</p>
 
 ```python
 def add(
@@ -87,7 +87,7 @@ The new dataset following the addition.
 
 ### download
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L175)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L175)</p>
 
 ```python
 def download(self, overwrite: bool = False) -> Self:
@@ -112,7 +112,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/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L91)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L91)</p>
 
 ```python
 def from_upstream(
@@ -144,7 +144,7 @@ The dataset, with contents downloaded from upstream.
 
 ### inplace\_add
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L300)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L300)</p>
 
 ```python
 def inplace_add(
@@ -177,7 +177,7 @@ This dataset following the in-place addition.
 
 ### inplace\_sub
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L329)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L329)</p>
 
 ```python
 def inplace_sub(
@@ -203,7 +203,7 @@ This dataset following the in-place subtraction.
 
 ### sub
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L278)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L278)</p>
 
 ```python
 def sub(
@@ -229,7 +229,7 @@ The new dataset following the subtraction.
 
 ### sync
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L211)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L211)</p>
 
 ```python
 def sync(self) -> Self:
@@ -246,7 +246,7 @@ This dataset after the in-place sync, useful for chaining methods.
 
 ### upload
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L130)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L130)</p>
 
 ```python
 def upload(self, overwrite: bool = False) -> Self:
@@ -271,7 +271,7 @@ This dataset, useful for chaining methods.
 
 ### upstream\_diff
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L223)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L223)</p>
 
 ```python
 def upstream_diff(self) -> Self:
@@ -289,7 +289,7 @@ This dataset after printing the diff, useful for chaining methods.
 
 ### \_\_add\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L353)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L353)</p>
 
 ```python
 def __add__(
@@ -316,7 +316,7 @@ The new dataset following the addition.
 
 ### \_\_contains\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L474)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L474)</p>
 
 ```python
 def __contains__(
@@ -343,7 +343,7 @@ Boolean, whether the passed Dataset is a subset of this one.
 
 ### \_\_getitem\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L504)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L504)</p>
 
 ```python
 def __getitem__(self, item: Union[int, slice]) -> Union[Any, Dataset]:
@@ -367,7 +367,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/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L397)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L397)</p>
 
 ```python
 def __iadd__(
@@ -393,7 +393,7 @@ This dataset following the in-place addition.
 
 ### \_\_init\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L16)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L16)</p>
 
 ```python
 def __init__(
@@ -427,7 +427,7 @@ Initialize a local dataset.
 
 ### \_\_isub\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L448)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L448)</p>
 
 ```python
 def __isub__(
@@ -453,7 +453,7 @@ This dataset following the in-place subtraction.
 
 ### \_\_iter\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L464)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L464)</p>
 
 ```python
 def __iter__(self) -> Any:
@@ -469,7 +469,7 @@ The next instance in the dataset.
 
 ### \_\_len\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L495)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L495)</p>
 
 ```python
 def __len__(self) -> int:
@@ -485,7 +485,7 @@ The number of entries in the dataset.
 
 ### \_\_radd\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L370)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L370)</p>
 
 ```python
 def __radd__(
@@ -520,7 +520,7 @@ The new dataset following the addition.
 
 ### \_\_rsub\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L430)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L430)</p>
 
 ```python
 def __rsub__(
@@ -548,7 +548,7 @@ The new dataset following the subtraction.
 
 ### \_\_sub\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/dataset.py#L413)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/dataset.py#L413)</p>
 
 ```python
 def __sub__(

diff --git a/python/classes/evals/logging/Context.mdx b/python/classes/evals/logging/Context.mdx
@@ -6,7 +6,7 @@ title: 'Context'
 class Context
 ```
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L137)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L137)</p>
 
 
 
@@ -16,7 +16,7 @@ class Context
 
 ### \_\_enter\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L142)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L142)</p>
 
 ```python
 def __enter__(self):
@@ -28,7 +28,7 @@ def __enter__(self):
 
 ### \_\_exit\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L147)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L147)</p>
 
 ```python
 def __exit__(self, *args, **kwargs):
@@ -40,7 +40,7 @@ def __exit__(self, *args, **kwargs):
 
 ### \_\_init\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L139)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L139)</p>
 
 ```python
 def __init__(self, context: str):

diff --git a/python/classes/evals/logging/Entries.mdx b/python/classes/evals/logging/Entries.mdx
@@ -6,7 +6,7 @@ title: 'Entries'
 class Entries
 ```
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L151)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L151)</p>
 
 
 
@@ -16,7 +16,7 @@ class Entries
 
 ### \_\_enter\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L156)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L156)</p>
 
 ```python
 def __enter__(self):
@@ -28,7 +28,7 @@ def __enter__(self):
 
 ### \_\_exit\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L164)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L164)</p>
 
 ```python
 def __exit__(self, *args, **kwargs):
@@ -40,7 +40,7 @@ def __exit__(self, *args, **kwargs):
 
 ### \_\_init\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L153)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L153)</p>
 
 ```python
 def __init__(self, **entries):

diff --git a/python/classes/evals/logging/Experiment.mdx b/python/classes/evals/logging/Experiment.mdx
@@ -6,7 +6,7 @@ title: 'Experiment'
 class Experiment
 ```
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L191)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L191)</p>
 
 
 
@@ -16,7 +16,7 @@ class Experiment
 
 ### \_\_enter\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L196)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L196)</p>
 
 ```python
 def __enter__(self):
@@ -28,7 +28,7 @@ def __enter__(self):
 
 ### \_\_exit\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L204)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L204)</p>
 
 ```python
 def __exit__(self, *args, **kwargs):
@@ -40,7 +40,7 @@ def __exit__(self, *args, **kwargs):
 
 ### \_\_init\_\_
 
-<p align="right">[source code](https://github.com/unifyai/unify/tree/f0d2aa10f7176b6a54ab98b23a769ef2b7bdeb9f/unify/evals/logging.py#L193)</p>
+<p align="right">[source code](https://github.com/unifyai/unify/tree/649c8304a89e3af40003ae5c1e211575f256a4ed/unify/evals/logging.py#L193)</p>
 
 ```python
 def __init__(self, name: str):