pin_write
boards.BaseBoard.pin_write(self, x, name=None, type=None, title=None, description=None, metadata=None, versioned=None, created=None)
Write a pin object to the board.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
x |
An object (e.g. a pandas DataFrame) to pin. | required | |
name |
typing.Optional[str] | Pin name. | None |
type |
typing.Optional[str] | File type used to save x to disk. May be “csv”, “arrow”, “parquet”, “joblib”, or “json”. |
None |
title |
typing.Optional[str] | A title for the pin; most important for shared boards so that others can understand what the pin contains. If omitted, a brief description of the contents will be automatically generated. | None |
description |
typing.Optional[str] | A detailed description of the pin contents. | None |
metadata |
typing.Optional[typing.Mapping] | A dictionary containing additional metadata to store with the pin. This gets stored on the Meta.user field. | None |
versioned |
typing.Optional[bool] | Whether the pin should be versioned. Defaults to versioning. | None |
created |
typing.Optional[datetime.datetime] | A date to store in the Meta.created field. This field may be used as part of the pin version name. | None |