Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@unify-dev-bot
unify-dev-bot committed Feb 27, 2025
1 parent bd0b3a7 commit 7d53f08
Show file tree
Hide file tree
Showing 76 changed files with 479 additions and 479 deletions.
54 changes: 27 additions & 27 deletions python/classes/logging/dataset/Dataset.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ title: 'Dataset'
class Dataset
```

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L19)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L19)</p>



### \_\_init\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L20)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L20)</p>

```python
def __init__(
Expand Down Expand Up @@ -46,7 +46,7 @@ Initialize a local dataset.

### allow\_duplicates

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L73)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L73)</p>

```python
def allow_duplicates(self) -> bool:
Expand All @@ -58,7 +58,7 @@ Whether to allow duplicates in the dataset.

### name

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L66)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L66)</p>

```python
def name(self) -> str:
Expand All @@ -72,7 +72,7 @@ Name of the dataset.

### set\_allow\_duplicates

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L106)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L106)</p>

```python
def set_allow_duplicates(self, allow_duplicates: bool) -> Self:
Expand All @@ -94,7 +94,7 @@ This dataset, useful for chaining methods.

### set\_name

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L93)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L93)</p>

```python
def set_name(self, name: str) -> Self:
Expand All @@ -118,7 +118,7 @@ This dataset, useful for chaining methods.

### add

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L260)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L260)</p>

```python
def add(
Expand Down Expand Up @@ -151,7 +151,7 @@ The new dataset following the addition.

### download

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L180)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L180)</p>

```python
def download(self, overwrite: bool = False) -> Self:
Expand All @@ -176,7 +176,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/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L119)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L119)</p>

```python
def from_upstream(
Expand Down Expand Up @@ -208,7 +208,7 @@ The dataset, with contents downloaded from upstream.

### inplace\_add

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L309)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L309)</p>

```python
def inplace_add(
Expand Down Expand Up @@ -241,7 +241,7 @@ This dataset following the in-place addition.

### inplace\_sub

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L336)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L336)</p>

```python
def inplace_sub(
Expand All @@ -267,7 +267,7 @@ This dataset following the in-place subtraction.

### sub

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L287)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L287)</p>

```python
def sub(
Expand All @@ -293,7 +293,7 @@ The new dataset following the subtraction.

### sync

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L220)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L220)</p>

```python
def sync(self) -> Self:
Expand All @@ -310,7 +310,7 @@ This dataset after the in-place sync, useful for chaining methods.

### upload

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L155)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L155)</p>

```python
def upload(self, overwrite: bool = False) -> Self:
Expand All @@ -335,7 +335,7 @@ This dataset, useful for chaining methods.

### upstream\_diff

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L232)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L232)</p>

```python
def upstream_diff(self) -> Self:
Expand All @@ -353,7 +353,7 @@ This dataset after printing the diff, useful for chaining methods.

### \_\_add\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L358)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L358)</p>

```python
def __add__(
Expand All @@ -380,7 +380,7 @@ The new dataset following the addition.

### \_\_contains\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L479)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L479)</p>

```python
def __contains__(
Expand All @@ -407,7 +407,7 @@ Boolean, whether the passed Dataset is a subset of this one.

### \_\_getitem\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L529)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L529)</p>

```python
def __getitem__(self, item: Union[int, slice]) -> Union[Any, Dataset]:
Expand All @@ -431,7 +431,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/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L402)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L402)</p>

```python
def __iadd__(
Expand All @@ -457,7 +457,7 @@ This dataset following the in-place addition.

### \_\_isub\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L453)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L453)</p>

```python
def __isub__(
Expand All @@ -483,7 +483,7 @@ This dataset following the in-place subtraction.

### \_\_iter\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L469)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L469)</p>

```python
def __iter__(self) -> Any:
Expand All @@ -499,7 +499,7 @@ The next instance in the dataset.

### \_\_len\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L520)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L520)</p>

```python
def __len__(self) -> int:
Expand All @@ -515,7 +515,7 @@ The number of entries in the dataset.

### \_\_radd\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L375)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L375)</p>

```python
def __radd__(
Expand Down Expand Up @@ -550,7 +550,7 @@ The new dataset following the addition.

### \_\_repr\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L572)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L572)</p>

```python
def __repr__(self):
Expand All @@ -562,7 +562,7 @@ def __repr__(self):

### \_\_rsub\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L435)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L435)</p>

```python
def __rsub__(
Expand Down Expand Up @@ -590,7 +590,7 @@ The new dataset following the subtraction.

### \_\_setitem\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L550)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L550)</p>

```python
def __setitem__(self, item: Union[int, slice], value: Union[Any, Dataset]):
Expand All @@ -602,7 +602,7 @@ def __setitem__(self, item: Union[int, slice], value: Union[Any, Dataset]):

### \_\_sub\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/dataset.py#L418)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/dataset.py#L418)</p>

```python
def __sub__(
Expand Down
8 changes: 4 additions & 4 deletions python/classes/logging/logs/ColumnContext.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ title: 'ColumnContext'
class ColumnContext
```

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L147)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L147)</p>



### \_\_init\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L148)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L148)</p>

```python
def __init__(self, context: str):
Expand All @@ -26,7 +26,7 @@ def __init__(self, context: str):

### \_\_enter\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L151)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L151)</p>

```python
def __enter__(self):
Expand All @@ -38,7 +38,7 @@ def __enter__(self):

### \_\_exit\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L156)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L156)</p>

```python
def __exit__(self, *args, **kwargs):
Expand Down
8 changes: 4 additions & 4 deletions python/classes/logging/logs/Entries.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ title: 'Entries'
class Entries
```

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L160)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L160)</p>



### \_\_init\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L161)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L161)</p>

```python
def __init__(self, **entries):
Expand All @@ -26,7 +26,7 @@ def __init__(self, **entries):

### \_\_enter\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L164)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L164)</p>

```python
def __enter__(self):
Expand All @@ -38,7 +38,7 @@ def __enter__(self):

### \_\_exit\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L172)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L172)</p>

```python
def __exit__(self, *args, **kwargs):
Expand Down
8 changes: 4 additions & 4 deletions python/classes/logging/logs/Experiment.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ title: 'Experiment'
class Experiment
```

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L198)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L198)</p>



### \_\_init\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L199)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L199)</p>

```python
def __init__(self, name: Optional[Union[str, int]] = None, overwrite: bool = False):
Expand All @@ -26,7 +26,7 @@ def __init__(self, name: Optional[Union[str, int]] = None, overwrite: bool = Fal

### \_\_enter\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L213)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L213)</p>

```python
def __enter__(self):
Expand All @@ -38,7 +38,7 @@ def __enter__(self):

### \_\_exit\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/09eed19cb2f7345e846baeb4ba46bfa082a39a97/unify/logging/logs.py#L224)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/af419f366ac1aad32f7ebba036baa1e4b6a82017/unify/logging/logs.py#L224)</p>

```python
def __exit__(self, *args, **kwargs):
Expand Down
Loading

0 comments on commit 7d53f08

Please sign in to comment.