flair.models.LanguageModel

class flair.models.LanguageModel(dictionary, is_forward_lm, hidden_size, nlayers, embedding_size=100, nout=None, document_delimiter='\\n', dropout=0.1, recurrent_type='LSTM', has_decoder=True)View on GitHub

Bases: Module

Container module with an encoder, a recurrent module, and a decoder.

__init__(dictionary, is_forward_lm, hidden_size, nlayers, embedding_size=100, nout=None, document_delimiter='\\n', dropout=0.1, recurrent_type='LSTM', has_decoder=True)View on GitHub

Initialize internal Module state, shared by both nn.Module and ScriptModule.

Methods

__init__(dictionary, is_forward_lm, ...[, ...])	Initialize internal Module state, shared by both nn.Module and ScriptModule.
add_module(name, module)	Add a child module to the current module.
apply(fn)	Apply fn recursively to every submodule (as returned by .children()) as well as self.
bfloat16()	Casts all floating point parameters and buffers to bfloat16 datatype.
buffers([recurse])	Return an iterator over module buffers.
calculate_perplexity(text)
children()	Return an iterator over immediate children modules.
compile(*args, **kwargs)	Compile this Module's forward using torch.compile().
cpu()	Move all model parameters and buffers to the CPU.
cuda([device])	Move all model parameters and buffers to the GPU.
double()	Casts all floating point parameters and buffers to double datatype.
eval()	Set the module in evaluation mode.
extra_repr()	Set the extra representation of the module.
float()	Casts all floating point parameters and buffers to float datatype.
forward(input, hidden[, ...])	Define the computation performed at every call.
generate_text([prefix, ...])
get_buffer(target)	Return the buffer given by target if it exists, otherwise throw an error.
get_extra_state()	Return any extra state to include in the module's state_dict.
get_output(text)
get_parameter(target)	Return the parameter given by target if it exists, otherwise throw an error.
get_representation(strings, start_marker, ...)
get_submodule(target)	Return the submodule given by target if it exists, otherwise throw an error.
half()	Casts all floating point parameters and buffers to half datatype.
init_hidden(bsz)
init_weights()
initialize(matrix)
ipu([device])	Move all model parameters and buffers to the IPU.
load_checkpoint(model_file)
load_language_model(model_file[, has_decoder])
load_state_dict(state_dict[, strict, assign])	Copy parameters and buffers from state_dict into this module and its descendants.
modules()	Return an iterator over all modules in the network.
mtia([device])	Move all model parameters and buffers to the MTIA.
named_buffers([prefix, recurse, ...])	Return an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
named_children()	Return an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
named_modules([memo, prefix, remove_duplicate])	Return an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
named_parameters([prefix, recurse, ...])	Return an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
parameters([recurse])	Return an iterator over module parameters.
register_backward_hook(hook)	Register a backward hook on the module.
register_buffer(name, tensor[, persistent])	Add a buffer to the module.
register_forward_hook(hook, *[, prepend, ...])	Register a forward hook on the module.
register_forward_pre_hook(hook, *[, ...])	Register a forward pre-hook on the module.
register_full_backward_hook(hook[, prepend])	Register a backward hook on the module.
register_full_backward_pre_hook(hook[, prepend])	Register a backward pre-hook on the module.
register_load_state_dict_post_hook(hook)	Register a post-hook to be run after module's load_state_dict() is called.
register_load_state_dict_pre_hook(hook)	Register a pre-hook to be run before module's load_state_dict() is called.
register_module(name, module)	Alias for add_module().
register_parameter(name, param)	Add a parameter to the module.
register_state_dict_post_hook(hook)	Register a post-hook for the state_dict() method.
register_state_dict_pre_hook(hook)	Register a pre-hook for the state_dict() method.
repackage_hidden(h)	Wraps hidden states in new Variables, to detach them from their history.
requires_grad_([requires_grad])	Change if autograd should record operations on parameters in this module.
save(file)
save_checkpoint(file, optimizer, epoch, ...)
set_extra_state(state)	Set extra state contained in the loaded state_dict.
set_hidden(hidden)
set_submodule(target, module)	Set the submodule given by target if it exists, otherwise throw an error.
share_memory()	See torch.Tensor.share_memory_().
state_dict(*args[, destination, prefix, ...])	Return a dictionary containing references to the whole state of the module.
to(*args, **kwargs)	Move and/or cast the parameters and buffers.
to_empty(*, device[, recurse])	Move the parameters and buffers to the specified device without copying storage.
train([mode])	Set the module in training mode.
type(dst_type)	Casts all parameters and buffers to dst_type.
xpu([device])	Move all model parameters and buffers to the XPU.
zero_grad([set_to_none])	Reset gradients of all model parameters.

Attributes

T_destination
call_super_init
dump_patches
training

init_weights()View on GitHub

set_hidden(hidden)View on GitHub

forward(input, hidden, ordered_sequence_lengths=None, decode=True)View on GitHub

Define the computation performed at every call.

Should be overridden by all subclasses.

Note

Although the recipe for forward pass needs to be defined within this function, one should call the Module instance afterwards instead of this since the former takes care of running the registered hooks while the latter silently ignores them.

init_hidden(bsz)View on GitHub

get_representation(strings, start_marker, end_marker, chars_per_chunk=512)View on GitHub

get_output(text)View on GitHub

repackage_hidden(h)View on GitHub

Wraps hidden states in new Variables, to detach them from their history.

static initialize(matrix)View on GitHub

classmethod load_language_model(model_file, has_decoder=True)View on GitHub

classmethod load_checkpoint(model_file)View on GitHub

save_checkpoint(file, optimizer, epoch, split, loss)View on GitHub

save(file)View on GitHub

generate_text(prefix='\\n', number_of_characters=1000, temperature=1.0, break_on_suffix=None)View on GitHub

Return type:

tuple[str, float]

calculate_perplexity(text)View on GitHub

Return type:

float