Vllm.Multimodal.Inputs.MultiModalKwargsItem (VLLM v0.3.0)

Copy Markdown View Source

A collection of

[MultiModalFieldElem][vllm.multimodal.inputs.MultiModalFieldElem] corresponding to a data item in [MultiModalDataItems][vllm.multimodal.parse.MultiModalDataItems].

Summary

Functions

D.clear() -> None. Remove all items from D.

Python method MultiModalKwargsItem.copy.

Convenience class for testing.

Python method MultiModalKwargsItem.from_elems.

Python method MultiModalKwargsItem.fromkeys.

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

Python method MultiModalKwargsItem.get_data.

D.items() -> a set-like object providing a view on D's items

D.keys() -> a set-like object providing a view on D's keys

Initialize self. See help(type(self)) for accurate signature.

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

D.popitem() -> (k, v), remove and return some (key, value) pair

D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

D.values() -> an object providing a view on D's values

Types

t()

@opaque t()

Functions

clear(ref, opts \\ [])

@spec clear(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.clear() -> None. Remove all items from D.

Returns

  • term()

copy(ref, opts \\ [])

@spec copy(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

Python method MultiModalKwargsItem.copy.

Returns

  • term()

dummy(ref, modality, args, opts \\ [])

@spec dummy(SnakeBridge.Ref.t(), String.t(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

Convenience class for testing.

Parameters

  • modality (String.t())
  • nbytes (integer() default: 1)

Returns

  • term()

from_elems(ref, elems, opts \\ [])

@spec from_elems(SnakeBridge.Ref.t(), term(), keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

Python method MultiModalKwargsItem.from_elems.

Parameters

  • elems (term())

Returns

  • term()

fromkeys(ref, iterable, args, opts \\ [])

@spec fromkeys(SnakeBridge.Ref.t(), term(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

Python method MultiModalKwargsItem.fromkeys.

Parameters

  • iterable (term())
  • value (term() default: None)

Returns

  • term()

get(ref, key, args, opts \\ [])

@spec get(SnakeBridge.Ref.t(), term(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

Parameters

  • key (term())
  • default (term() default: None)

Returns

  • term()

get_data(ref, opts \\ [])

@spec get_data(
  SnakeBridge.Ref.t(),
  keyword()
) ::
  {:ok,
   %{
     optional(String.t()) =>
       (([(([term()] | [term()]) | term()) | {term(), term()}] | [term()])
        | term())
       | {term(), term()}
   }}
  | {:error, Snakepit.Error.t()}

Python method MultiModalKwargsItem.get_data.

Returns

  • %{ optional(String.t()) => ((list(((list(term()) | list(term())) | term()) | {term(), term()}) | list(term())) | term()) | {term(), term()} }

items(ref, opts \\ [])

@spec items(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.items() -> a set-like object providing a view on D's items

Returns

  • term()

keys(ref, opts \\ [])

@spec keys(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.keys() -> a set-like object providing a view on D's keys

Returns

  • term()

modality(ref)

@spec modality(SnakeBridge.Ref.t()) :: {:ok, term()} | {:error, Snakepit.Error.t()}

new(args, opts \\ [])

@spec new(
  [term()],
  keyword()
) :: {:ok, SnakeBridge.Ref.t()} | {:error, Snakepit.Error.t()}

Initialize self. See help(type(self)) for accurate signature.

Parameters

  • data (term() default: {})

pop(ref, key, args, opts \\ [])

@spec pop(SnakeBridge.Ref.t(), term(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

Parameters

  • key (term())
  • default (term() default: <object object at 0x7272d76e01c0>)

Returns

  • term()

popitem(ref, opts \\ [])

@spec popitem(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.popitem() -> (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

Returns

  • term()

setdefault(ref, key, args, opts \\ [])

@spec setdefault(SnakeBridge.Ref.t(), term(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

Parameters

  • key (term())
  • default (term() default: None)

Returns

  • term()

update(ref, args, opts \\ [])

@spec update(SnakeBridge.Ref.t(), [term()], keyword()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

Parameters

  • other (term() default: ())
  • kwds (term())

Returns

  • term()

values(ref, opts \\ [])

@spec values(
  SnakeBridge.Ref.t(),
  keyword()
) :: {:ok, term()} | {:error, Snakepit.Error.t()}

D.values() -> an object providing a view on D's values

Returns

  • term()