openvino_genai.StopCriteria#

class openvino_genai.StopCriteria#

Bases: pybind11_object

StopCriteria controls the stopping condition for grouped beam search. The following values are possible:: “openvino_genai.StopCriteria.EARLY” stops as soon as there are num_beams complete candidates. “openvino_genai.StopCriteria.HEURISTIC” stops when is it unlikely to find better candidates. “openvino_genai.StopCriteria.NEVER” stops when there cannot be better candidates.

Members:

EARLY

HEURISTIC

NEVER

__init__(self: openvino_genai.py_generate_pipeline.StopCriteria, value: int) → None#

Methods

`__delattr__`(name, /)	Implement delattr(self, name).
`__dir__`()	Default dir() implementation.
`__eq__`(self, other)
`__format__`(format_spec, /)	Default object formatter.
`__ge__`(value, /)	Return self>=value.
`__getattribute__`(name, /)	Return getattr(self, name).
`__getstate__`(self)
`__gt__`(value, /)	Return self>value.
`__hash__`(self)
`__index__`(self)
`__init__`(self, value)
`__init_subclass__`	This method is called when a class is subclassed.
`__int__`(self)
`__le__`(value, /)	Return self<=value.
`__lt__`(value, /)	Return self<value.
`__ne__`(self, other)
`__new__`(**kwargs)
`__reduce__`()	Helper for pickle.
`__reduce_ex__`(protocol, /)	Helper for pickle.
`__repr__`(self)
`__setattr__`(name, value, /)	Implement setattr(self, name, value).
`__setstate__`(self, state)
`__sizeof__`()	Size of object in memory, in bytes.
`__str__`(self)
`__subclasshook__`	Abstract classes can override this to customize issubclass().

Attributes

`EARLY`
`HEURISTIC`
`NEVER`
`__entries`
`__members__`
`name`
`value`

EARLY = <StopCriteria.EARLY: 0>#

HEURISTIC = <StopCriteria.HEURISTIC: 1>#

NEVER = <StopCriteria.NEVER: 2>#

__class__#: alias of pybind11_type

__delattr__(name, /)#: Implement delattr(self, name).

__dir__()#: Default dir() implementation.

__eq__(self: object, other: object) → bool#

__format__(format_spec, /)#: Default object formatter.

__ge__(value, /)#: Return self>=value.

__getattribute__(name, /)#: Return getattr(self, name).

__getstate__(self: object) → int#

__gt__(value, /)#: Return self>value.

__hash__(self: object) → int#

__index__(self: openvino_genai.py_generate_pipeline.StopCriteria) → int#

__init__(self: openvino_genai.py_generate_pipeline.StopCriteria, value: int) → None#

__init_subclass__()#

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__int__(self: openvino_genai.py_generate_pipeline.StopCriteria) → int#

__le__(value, /)#: Return self<=value.

__lt__(value, /)#: Return self<value.

__members__ = {'EARLY': <StopCriteria.EARLY: 0>, 'HEURISTIC': <StopCriteria.HEURISTIC: 1>, 'NEVER': <StopCriteria.NEVER: 2>}#

__ne__(self: object, other: object) → bool#

__new__(**kwargs)#

__reduce__()#: Helper for pickle.

__reduce_ex__(protocol, /)#: Helper for pickle.

__repr__(self: object) → str#

__setattr__(name, value, /)#: Implement setattr(self, name, value).

__setstate__(self: openvino_genai.py_generate_pipeline.StopCriteria, state: int) → None#

__sizeof__()#: Size of object in memory, in bytes.

__str__(self: object) → str#

__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

property name#

property value#