skbio.embedding.Embedding#

class skbio.embedding.Embedding(embedding, ids, **kwargs)[source]#

Embedding for a biological object.

Parameters:
embeddingarray_like

Embedding matrix where the first axis is indexed by ids.

idsarray_like

IDs of biological objects.

Attributes

embedding

The embedding tensor.

ids

IDs corresponding to each row of the embedding.

Methods

bytes()

Bytes representation of string encoding.

read([format])

Create a new Embedding instance from a file.

write(file[, format])

Write an instance of Embedding to a file.

Special methods

__str__()

Return str(self).

Special methods (inherited)

__eq__(value, /)

Return self==value.

__ge__(value, /)

Return self>=value.

__getstate__(/)

Helper for pickle.

__gt__(value, /)

Return self>value.

__hash__(/)

Return hash(self).

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

Details

embedding#

The embedding tensor.

ids#

IDs corresponding to each row of the embedding.

__str__()[source]#

Return str(self).