Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
unify-dev-bot committed Feb 24, 2025
1 parent 44c1ceb commit f4e0b49
Show file tree
Hide file tree
Showing 75 changed files with 474 additions and 474 deletions.
46 changes: 23 additions & 23 deletions python/classes/logging/dataset/Dataset.mdx
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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L19)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L19)</p>



### \_\_init\_\_

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

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

### name

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L62)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L62)</p>

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

### set\_name

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L82)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L82)</p>

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

### add

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L227)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L227)</p>

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

### download

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L157)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L157)</p>

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

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

### inplace\_add

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L276)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L276)</p>

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

### inplace\_sub

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L303)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L303)</p>

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

### sub

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L254)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L254)</p>

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

### sync

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L187)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L187)</p>

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

### upload

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L131)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L131)</p>

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

### upstream\_diff

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L199)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L199)</p>

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

### \_\_add\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L325)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L325)</p>

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

### \_\_contains\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L446)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L446)</p>

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

### \_\_getitem\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L496)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L496)</p>

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

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

### \_\_isub\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L420)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L420)</p>

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

### \_\_iter\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L436)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L436)</p>

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

### \_\_len\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L487)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L487)</p>

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

### \_\_radd\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L342)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L342)</p>

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

### \_\_rsub\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L402)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L402)</p>

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

### \_\_sub\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/dataset.py#L385)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/dataset.py#L385)</p>

```python
def __sub__(
Expand Down
8 changes: 4 additions & 4 deletions python/classes/logging/logs/ColumnContext.mdx
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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L147)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/logs.py#L147)</p>



### \_\_init\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L148)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L151)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L156)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/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
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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L160)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/logs.py#L160)</p>



### \_\_init\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L161)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L164)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L172)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/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
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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L198)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/logs.py#L198)</p>



### \_\_init\_\_

<p align="right">[source code](https://github.com/unifyai/unify/tree/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L199)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L213)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/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/fc26d5c449e76a682f3deb1e2d368b43c892e51d/unify/logging/logs.py#L224)</p>
<p align="right">[source code](https://github.com/unifyai/unify/tree/23437f43c2ebe49316aeef3c2057bdace11a3436/unify/logging/logs.py#L224)</p>

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

0 comments on commit f4e0b49

Please sign in to comment.