docarray.array.storage.annlite package

Submodules

• docarray.array.storage.annlite.backend module
  • AnnliteConfig
    • AnnliteConfig.n_dim
    • AnnliteConfig.metric
    • AnnliteConfig.list_like
    • AnnliteConfig.serialize_config
    • AnnliteConfig.data_path
    • AnnliteConfig.ef_construction
    • AnnliteConfig.ef_search
    • AnnliteConfig.max_connection
    • AnnliteConfig.n_components
    • AnnliteConfig.columns
    • AnnliteConfig.root_id
  • BackendMixin
    • BackendMixin.TYPE_MAP
• docarray.array.storage.annlite.find module
  • FindMixin
• docarray.array.storage.annlite.getsetdel module
  • GetSetDelMixin
    • GetSetDelMixin.sync()
• docarray.array.storage.annlite.helper module
  • OffsetMapping
    • OffsetMapping.close()
    • OffsetMapping.create_table()
    • OffsetMapping.drop()
    • OffsetMapping.clear()
    • OffsetMapping.size
    • OffsetMapping.extend_doc_ids()
    • OffsetMapping.get_id_by_offset()
    • OffsetMapping.get_ids_by_offsets()
    • OffsetMapping.get_offsets_by_ids()
    • OffsetMapping.get_offset_by_id()
    • OffsetMapping.get_all_ids()
    • OffsetMapping.del_at_offset()
    • OffsetMapping.del_at_offsets()
    • OffsetMapping.insert_at_offset()
    • OffsetMapping.set_at_offset()
    • OffsetMapping.shift_offset()
    • OffsetMapping.commit()
    • OffsetMapping.drop_table()
    • OffsetMapping.dump()
    • OffsetMapping.execute()
    • OffsetMapping.execute_many()
    • OffsetMapping.load()
    • OffsetMapping.name
    • OffsetMapping.schema
• docarray.array.storage.annlite.seqlike module
  • SequenceLikeMixin
    • SequenceLikeMixin.append()
    • SequenceLikeMixin.clear()
    • SequenceLikeMixin.count()
    • SequenceLikeMixin.extend()
    • SequenceLikeMixin.index()
    • SequenceLikeMixin.insert()
    • SequenceLikeMixin.pop()
    • SequenceLikeMixin.remove()
    • SequenceLikeMixin.reverse()

Module contents

class docarray.array.storage.annlite.StorageMixins(*args, **kwds)

Bases: FindMixin, BackendMixin, GetSetDelMixin, SequenceLikeMixin, ABC

TYPE_MAP: Dict[str, TypeMap] = {'float': TypeMap(type='float', converter=<class 'float'>), 'int': TypeMap(type='int', converter=<function _safe_cast_int>), 'str': TypeMap(type='str', converter=<class 'str'>)}

append(value, **kwargs)

Append doc to the end of the array.

Parameters:

value (Document) – The doc needs to be appended.

clear()

Clear the data of DocumentArray

count(value) → integer -- return number of occurrences of value

extend(values, **kwargs)

S.extend(iterable) – extend sequence by appending elements from the iterable

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

insert(index, value, **kwargs)

Insert doc at index.

Parameters:

• index (int) – Position of the insertion.

• value (Document) – The doc needs to be inserted.

• kwargs – Additional Arguments that are passed to the Document Store. This has no effect for in-memory DocumentArray.

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

remove(value)

S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()

S.reverse() – reverse IN PLACE

sync()

class docarray.array.storage.annlite.AnnliteConfig(n_dim, metric='cosine', list_like=True, serialize_config=<factory>, data_path=None, ef_construction=None, ef_search=None, max_connection=None, n_components=None, columns=None, root_id=True)

Bases: object

n_dim: int

metric: str = 'cosine'

list_like: bool = True

serialize_config: Dict

data_path: Optional[str] = None

ef_construction: Optional[int] = None

ef_search: Optional[int] = None

max_connection: Optional[int] = None

n_components: Optional[int] = None

columns: Optional[Union[List[Tuple[str, str]], Dict[str, str]]] = None

root_id: bool = True