Package de.uni_mannheim.informatik.dws.melt.matching_ml.python.nlptransformers

Enum TransformersMultiProcessing

java.lang.Object

java.lang.Enum<TransformersMultiProcessing>

de.uni_mannheim.informatik.dws.melt.matching_ml.python.nlptransformers.TransformersMultiProcessing

All Implemented Interfaces:

Serializable, Comparable<TransformersMultiProcessing>, java.lang.constant.Constable

public enum TransformersMultiProcessing
extends Enum<TransformersMultiProcessing>

The transformers library may not free all memory from GPU. Thus the prediction and training are wrapped in an external process. This enum defines how the process is started and if multiprocessing should be used at all.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT_MULTI_PROCESS	This uses the default start method for the operating system.
FORK	This uses os.fork() to fork the python interpreter.
FORKSERVER	This uses a server process to start a new process.
NO_MULTI_PROCESS	The transformer model is executed directly in the main process.
SPAWN	The main process starts a fresh python interpreter.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TransformersMultiProcessing()

Method Summary

Modifier and Type	Method	Description
String	toString()
static TransformersMultiProcessing	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TransformersMultiProcessing[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_MULTI_PROCESS

public static final TransformersMultiProcessing NO_MULTI_PROCESS

The transformer model is executed directly in the main process. If you call the Transformers matcher in MELT multiple times, then this can lead to memory issues.

DEFAULT_MULTI_PROCESS

public static final TransformersMultiProcessing DEFAULT_MULTI_PROCESS

This uses the default start method for the operating system. This is SPAWN for Windows and macOS, and FORK for Unix. See also the python documentation about it.

SPAWN

public static final TransformersMultiProcessing SPAWN

The main process starts a fresh python interpreter. Available on Unix and Windows. See also the python documentation about it.

FORK

public static final TransformersMultiProcessing FORK

This uses os.fork() to fork the python interpreter. Available on Unix only. This may result in the following error: Cannot re-initialize CUDA in forked subprocess. To use CUDA with multiprocessing, you must use the 'spawn' start method. . See also the python documentation about it.

FORKSERVER

public static final TransformersMultiProcessing FORKSERVER

This uses a server process to start a new process. Available only on Unix. See also the python documentation about it.

Constructor Details

TransformersMultiProcessing

private TransformersMultiProcessing()

Method Details

values

public static TransformersMultiProcessing[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TransformersMultiProcessing valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<TransformersMultiProcessing>