# flytekit.core.artifact

## Directory

### Classes

| Class | Description |
|-|-|
| [`Artifact`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactartifact) | An Artifact is effectively just a metadata layer on top of data that exists in Flyte. |
| [`ArtifactIDSpecification`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactartifactidspecification) | This is a special object that helps specify how Artifacts are to be created. |
| [`ArtifactQuery`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactartifactquery) |  |
| [`DefaultArtifactSerializationHandler`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactdefaultartifactserializationhandler) |  |
| [`InputsBase`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactinputsbase) | A class to provide better partition semantics. |
| [`Partition`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactpartition) |  |
| [`Partitions`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactpartitions) |  |
| [`Serializer`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactserializer) |  |
| [`TimePartition`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifacttimepartition) |  |

### Protocols

| Protocol | Description |
|-|-|
| [`ArtifactSerializationHandler`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/page.md#flytekitcoreartifactartifactserializationhandler) | This protocol defines the interface for serializing artifact-related entities down to Flyte IDL. |

### Variables

| Property | Type | Description |
|-|-|-|
| `Inputs` | `InputsBase` |  |
| `MAX_PARTITIONS` | `int` |  |
| `O` | `TypeVar` |  |
| `TIME_PARTITION_KWARG` | `str` |  |

## flytekit.core.artifact.Artifact

An Artifact is effectively just a metadata layer on top of data that exists in Flyte. Most data of interest
will be the output of tasks and workflows. The other category is user uploads.

This Python class has limited purpose, as a way for users to specify that tasks/workflows create Artifacts
and the manner (i.e. name, partitions) in which they are created.

Control creation parameters at task/workflow execution time ::

    @task
    def t1() -> Annotated[nn.Module, Artifact(name="my.artifact.name")]:
        ...

### Parameters

```python
class Artifact(
    project: Optional[str],
    domain: Optional[str],
    name: Optional[str],
    version: Optional[str],
    time_partitioned: bool,
    time_partition: Optional[TimePartition],
    time_partition_granularity: Optional[Granularity],
    partition_keys: Optional[typing.List[str]],
    partitions: Optional[Union[Partitions, typing.Dict[str, str]]],
)
```
| Parameter | Type | Description |
|-|-|-|
| `project` | `Optional[str]` | Should not be directly user provided, the project/domain will come from the project/domain of the execution that produced the output. These values will be filled in automatically when retrieving however. |
| `domain` | `Optional[str]` | See above. |
| `name` | `Optional[str]` | The name of the Artifact. This should be user provided. |
| `version` | `Optional[str]` | Version of the Artifact, typically the execution ID, plus some additional entropy. Not user provided. |
| `time_partitioned` | `bool` | Whether or not this Artifact will have a time partition. |
| `time_partition` | `Optional[TimePartition]` | If you want to manually pass in the full TimePartition object |
| `time_partition_granularity` | `Optional[Granularity]` | If you don't want to manually pass in the full TimePartition object, but want to control the granularity when one is automatically created for you. Note that consistency checking is limited while in alpha. |
| `partition_keys` | `Optional[typing.List[str]]` | This is a list of keys that will be used to partition the Artifact. These are not the values. Values are set via a () on the artifact and will end up in the partition_values field. |
| `partitions` | `Optional[Union[Partitions, typing.Dict[str, str]]]` | This is a dictionary of partition keys to values. |

### Properties

| Property | Type | Description |
|-|-|-|
| `concrete_artifact_id` | `None` |  |
| `partitions` | `None` |  |
| `time_partition` | `None` |  |

### Methods

| Method | Description |
|-|-|
| [`create_from()`](#create_from) | This function allows users to declare partition values dynamically from the body of a task. |
| [`embed_as_query()`](#embed_as_query) | This should only be called in the context of a Trigger. |
| [`query()`](#query) |  |
| [`to_id_idl()`](#to_id_idl) | Converts this object to the IDL representation. |

#### create_from()

```python
def create_from(
    o: O,
    card: Optional[SerializableToString],
    args: *args,
    kwargs,
) -> O
```
This function allows users to declare partition values dynamically from the body of a task. Note that you'll
still need to annotate your task function output with the relevant Artifact object. Below, one of the partition
values is bound to an input, and the other is set at runtime. Note that since tasks are not run at compile
time, flytekit cannot check that you've bound all the partition values. It's up to you to ensure that you've
done so.

    Pricing = Artifact(name="pricing", partition_keys=["region"])
    EstError = Artifact(name="estimation_error", partition_keys=["dataset"], time_partitioned=True)

    @task
    def t1() -> Annotated[pd.DataFrame, Pricing], Annotated[float, EstError]:
        df = get_pricing_results()
        dt = get_time()
        return Pricing.create_from(df, region="dubai"),             EstError.create_from(msq_error, dataset="train", time_partition=dt)

You can mix and match with the input syntax as well.

    @task
    def my_task() -> Annotated[pd.DataFrame, RideCountData(region=Inputs.region)]:
        ...
        return RideCountData.create_from(df, time_partition=datetime.datetime.now())

| Parameter | Type | Description |
|-|-|-|
| `o` | `O` | |
| `card` | `Optional[SerializableToString]` | |
| `args` | `*args` | |
| `kwargs` | `**kwargs` | |

#### embed_as_query()

```python
def embed_as_query(
    partition: Optional[str],
    bind_to_time_partition: Optional[bool],
    expr: Optional[str],
    op: Optional[Op],
) -> art_id.ArtifactQuery
```
This should only be called in the context of a Trigger. The type of query this returns is different from the
query() function. This type of query is used to reference the triggering artifact, rather than running a query.

| Parameter | Type | Description |
|-|-|-|
| `partition` | `Optional[str]` | Can embed a time partition |
| `bind_to_time_partition` | `Optional[bool]` | Set to true if you want to bind to a time partition |
| `expr` | `Optional[str]` | Only valid if there's a time partition. |
| `op` | `Optional[Op]` | If expr is given, then op is what to do with it. |

#### query()

```python
def query(
    project: Optional[str],
    domain: Optional[str],
    time_partition: Optional[Union[datetime.datetime, TimePartition, art_id.InputBindingData]],
    partitions: Optional[Union[typing.Dict[str, str], Partitions]],
    kwargs,
) -> ArtifactQuery
```
| Parameter | Type | Description |
|-|-|-|
| `project` | `Optional[str]` | |
| `domain` | `Optional[str]` | |
| `time_partition` | `Optional[Union[datetime.datetime, TimePartition, art_id.InputBindingData]]` | |
| `partitions` | `Optional[Union[typing.Dict[str, str], Partitions]]` | |
| `kwargs` | `**kwargs` | |

#### to_id_idl()

```python
def to_id_idl()
```
Converts this object to the IDL representation.
This is here instead of translator because it's in the interface, a relatively simple proto object
that's exposed to the user.

## flytekit.core.artifact.ArtifactIDSpecification

This is a special object that helps specify how Artifacts are to be created. See the comment in the
call function of the main Artifact class. Also see the handling code in transform_variable_map for more
information. There's a limited set of information that we ultimately need in a TypedInterface, so it
doesn't make sense to carry the full Artifact object around. This object should be sufficient, despite
having a pointer to the main artifact.

### Parameters

```python
class ArtifactIDSpecification(
    a: Artifact,
)
```
| Parameter | Type | Description |
|-|-|-|
| `a` | `Artifact` | |

### Methods

| Method | Description |
|-|-|
| [`bind_partitions()`](#bind_partitions) |  |
| [`to_partial_artifact_id()`](#to_partial_artifact_id) |  |

#### bind_partitions()

```python
def bind_partitions(
    args,
    kwargs,
) -> ArtifactIDSpecification
```
| Parameter | Type | Description |
|-|-|-|
| `args` | `*args` | |
| `kwargs` | `**kwargs` | |

#### to_partial_artifact_id()

```python
def to_partial_artifact_id()
```
## flytekit.core.artifact.ArtifactQuery

### Parameters

```python
class ArtifactQuery(
    artifact: Artifact,
    name: str,
    project: Optional[str],
    domain: Optional[str],
    time_partition: Optional[TimePartition],
    partitions: Optional[Partitions],
    tag: Optional[str],
)
```
| Parameter | Type | Description |
|-|-|-|
| `artifact` | `Artifact` | |
| `name` | `str` | |
| `project` | `Optional[str]` | |
| `domain` | `Optional[str]` | |
| `time_partition` | `Optional[TimePartition]` | |
| `partitions` | `Optional[Partitions]` | |
| `tag` | `Optional[str]` | |

### Properties

| Property | Type | Description |
|-|-|-|
| `bound` | `None` |  |

### Methods

| Method | Description |
|-|-|
| [`get_partition_str()`](#get_partition_str) |  |
| [`get_str()`](#get_str) |  |
| [`get_time_partition_str()`](#get_time_partition_str) |  |
| [`to_flyte_idl()`](#to_flyte_idl) |  |

#### get_partition_str()

```python
def get_partition_str(
    kwargs,
) -> str
```
| Parameter | Type | Description |
|-|-|-|
| `kwargs` | `**kwargs` | |

#### get_str()

```python
def get_str(
    kwargs,
)
```
| Parameter | Type | Description |
|-|-|-|
| `kwargs` | `**kwargs` | |

#### get_time_partition_str()

```python
def get_time_partition_str(
    kwargs,
) -> str
```
| Parameter | Type | Description |
|-|-|-|
| `kwargs` | `**kwargs` | |

#### to_flyte_idl()

```python
def to_flyte_idl(
    kwargs,
) -> art_id.ArtifactQuery
```
| Parameter | Type | Description |
|-|-|-|
| `kwargs` | `**kwargs` | |

## flytekit.core.artifact.ArtifactSerializationHandler

This protocol defines the interface for serializing artifact-related entities down to Flyte IDL.

```python
protocol ArtifactSerializationHandler()
```
### Methods

| Method | Description |
|-|-|
| [`artifact_query_to_idl()`](#artifact_query_to_idl) |  |
| [`partitions_to_idl()`](#partitions_to_idl) |  |
| [`time_partition_to_idl()`](#time_partition_to_idl) |  |

#### artifact_query_to_idl()

```python
def artifact_query_to_idl(
    aq: ArtifactQuery,
    kwargs,
) -> art_id.ArtifactQuery
```
| Parameter | Type | Description |
|-|-|-|
| `aq` | `ArtifactQuery` | |
| `kwargs` | `**kwargs` | |

#### partitions_to_idl()

```python
def partitions_to_idl(
    p: Optional[Partitions],
    kwargs,
) -> Optional[art_id.Partitions]
```
| Parameter | Type | Description |
|-|-|-|
| `p` | `Optional[Partitions]` | |
| `kwargs` | `**kwargs` | |

#### time_partition_to_idl()

```python
def time_partition_to_idl(
    tp: Optional[TimePartition],
    kwargs,
) -> Optional[art_id.TimePartition]
```
| Parameter | Type | Description |
|-|-|-|
| `tp` | `Optional[TimePartition]` | |
| `kwargs` | `**kwargs` | |

## flytekit.core.artifact.DefaultArtifactSerializationHandler

### Methods

| Method | Description |
|-|-|
| [`artifact_query_to_idl()`](#artifact_query_to_idl) |  |
| [`partitions_to_idl()`](#partitions_to_idl) |  |
| [`time_partition_to_idl()`](#time_partition_to_idl) |  |

#### artifact_query_to_idl()

```python
def artifact_query_to_idl(
    aq: ArtifactQuery,
    kwargs,
) -> art_id.ArtifactQuery
```
| Parameter | Type | Description |
|-|-|-|
| `aq` | `ArtifactQuery` | |
| `kwargs` | `**kwargs` | |

#### partitions_to_idl()

```python
def partitions_to_idl(
    p: Optional[Partitions],
    kwargs,
) -> Optional[art_id.Partitions]
```
| Parameter | Type | Description |
|-|-|-|
| `p` | `Optional[Partitions]` | |
| `kwargs` | `**kwargs` | |

#### time_partition_to_idl()

```python
def time_partition_to_idl(
    tp: Optional[TimePartition],
    kwargs,
) -> Optional[art_id.TimePartition]
```
| Parameter | Type | Description |
|-|-|-|
| `tp` | `Optional[TimePartition]` | |
| `kwargs` | `**kwargs` | |

## flytekit.core.artifact.InputsBase

A class to provide better partition semantics
Used for invoking an Artifact to bind partition keys to input values.
If there's a good reason to use a metaclass in the future we can, but a simple instance suffices for now

## flytekit.core.artifact.Partition

### Parameters

```python
class Partition(
    value: Optional[art_id.LabelValue],
    name: str,
)
```
| Parameter | Type | Description |
|-|-|-|
| `value` | `Optional[art_id.LabelValue]` | |
| `name` | `str` | |

## flytekit.core.artifact.Partitions

### Parameters

```python
class Partitions(
    partitions: Optional[typing.Mapping[str, Union[str, art_id.InputBindingData, Partition]]],
)
```
| Parameter | Type | Description |
|-|-|-|
| `partitions` | `Optional[typing.Mapping[str, Union[str, art_id.InputBindingData, Partition]]]` | |

### Properties

| Property | Type | Description |
|-|-|-|
| `partitions` | `None` |  |

### Methods

| Method | Description |
|-|-|
| [`set_reference_artifact()`](#set_reference_artifact) |  |
| [`to_flyte_idl()`](#to_flyte_idl) |  |

#### set_reference_artifact()

```python
def set_reference_artifact(
    artifact: Artifact,
)
```
| Parameter | Type | Description |
|-|-|-|
| `artifact` | `Artifact` | |

#### to_flyte_idl()

```python
def to_flyte_idl(
    kwargs,
) -> Optional[art_id.Partitions]
```
| Parameter | Type | Description |
|-|-|-|
| `kwargs` | `**kwargs` | |

## flytekit.core.artifact.Serializer

### Methods

| Method | Description |
|-|-|
| [`artifact_query_to_idl()`](#artifact_query_to_idl) |  |
| [`partitions_to_idl()`](#partitions_to_idl) |  |
| [`register_serializer()`](#register_serializer) |  |
| [`time_partition_to_idl()`](#time_partition_to_idl) |  |

#### artifact_query_to_idl()

```python
def artifact_query_to_idl(
    aq: ArtifactQuery,
    kwargs,
) -> art_id.ArtifactQuery
```
| Parameter | Type | Description |
|-|-|-|
| `aq` | `ArtifactQuery` | |
| `kwargs` | `**kwargs` | |

#### partitions_to_idl()

```python
def partitions_to_idl(
    p: Optional[Partitions],
    kwargs,
) -> Optional[art_id.Partitions]
```
| Parameter | Type | Description |
|-|-|-|
| `p` | `Optional[Partitions]` | |
| `kwargs` | `**kwargs` | |

#### register_serializer()

```python
def register_serializer(
    serializer: ArtifactSerializationHandler,
)
```
| Parameter | Type | Description |
|-|-|-|
| `serializer` | `ArtifactSerializationHandler` | |

#### time_partition_to_idl()

```python
def time_partition_to_idl(
    tp: TimePartition,
    kwargs,
) -> Optional[art_id.TimePartition]
```
| Parameter | Type | Description |
|-|-|-|
| `tp` | `TimePartition` | |
| `kwargs` | `**kwargs` | |

## flytekit.core.artifact.TimePartition

### Parameters

```python
class TimePartition(
    value: Union[art_id.LabelValue, art_id.InputBindingData, str, datetime.datetime, None],
    op: Optional[Op],
    other: Optional[timedelta],
    granularity: Granularity,
)
```
| Parameter | Type | Description |
|-|-|-|
| `value` | `Union[art_id.LabelValue, art_id.InputBindingData, str, datetime.datetime, None]` | |
| `op` | `Optional[Op]` | |
| `other` | `Optional[timedelta]` | |
| `granularity` | `Granularity` | |

### Methods

| Method | Description |
|-|-|
| [`to_flyte_idl()`](#to_flyte_idl) |  |

#### to_flyte_idl()

```python
def to_flyte_idl(
    kwargs,
) -> Optional[art_id.TimePartition]
```
| Parameter | Type | Description |
|-|-|-|
| `kwargs` | `**kwargs` | |

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/flytekit-sdk/packages/flytekit.core.artifact.md
**HTML**: https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.core.artifact/