classifiers¶
-
class
hanlp.components.classifiers.transformer_classifier.
TransformerClassifier
(**kwargs)[source]¶ A classifier using transformer as encoder.
- Parameters
**kwargs – Passed to config.
-
build_criterion
(**kwargs)[source]¶ Implement this method to build criterion (loss function).
- Parameters
**kwargs – The subclass decides the method signature.
-
build_dataloader
(data, batch_size, shuffle, device, text_a_key, text_b_key, label_key, logger: logging.Logger = None, sorting=True, **kwargs) → torch.utils.data.dataloader.DataLoader[source]¶ Build dataloader for training, dev and test sets. It’s suggested to build vocabs in this method if they are not built yet.
- Parameters
data – Data representing samples, which can be a path or a list of samples.
batch_size – Number of samples per batch.
shuffle – Whether to shuffle this dataloader.
device – Device tensors should be loaded onto.
logger – Logger for reporting some message if dataloader takes a long time or if vocabs has to be built.
**kwargs – Arguments from
**self.config
.
-
build_metric
(**kwargs)[source]¶ Implement this to build metric(s).
- Parameters
**kwargs – The subclass decides the method signature.
-
build_model
(transformer, training=True, **kwargs) → torch.nn.modules.module.Module[source]¶ Build model.
- Parameters
training –
True
if called during training.**kwargs –
**self.config
.
-
build_vocabs
(trn, logger, **kwargs)[source]¶ Override this method to build vocabs.
- Parameters
trn – Training set.
logger – Logger for reporting progress.
-
evaluate_dataloader
(data: torch.utils.data.dataloader.DataLoader, criterion: Callable, metric, logger, ratio_width=None, filename=None, output=None, **kwargs)[source]¶ Evaluate on a dataloader.
- Parameters
data – Dataloader which can build from any data source.
criterion – Loss function.
metric – Metric(s).
output – Whether to save outputs into some file.
**kwargs – Not used.
-
execute_training_loop
(trn: torch.utils.data.dataloader.DataLoader, dev: torch.utils.data.dataloader.DataLoader, epochs, criterion, optimizer, metric, save_dir, logger: logging.Logger, devices, **kwargs)[source]¶ Implement this to run training loop.
- Parameters
trn – Training set.
dev – Development set.
epochs – Number of epochs.
criterion – Loss function.
optimizer – Optimizer(s).
metric – Metric(s)
save_dir – The directory to save this component.
logger – Logger for reporting progress.
devices – Devices this component and dataloader will live on.
ratio_width – The width of dataset size measured in number of characters. Used for logger to align messages.
**kwargs – Other hyper-parameters passed from sub-class.
-
fit
(trn_data, dev_data, save_dir, text_a_key=None, text_b_key=None, label_key=None, transformer=None, max_seq_length=512, truncate_long_sequences=True, lr=5e-05, transformer_lr=None, adam_epsilon=1e-06, weight_decay=0, warmup_steps=0.1, batch_size=32, batch_max_tokens=None, epochs=3, logger=None, devices: Union[float, int, List[int]] = None, **kwargs)[source]¶ Fit to data, triggers the training procedure. For training set and dev set, they shall be local or remote files.
- Parameters
trn_data – Training set.
dev_data – Development set.
save_dir – The directory to save trained component.
batch_size – The number of samples in a batch.
epochs – Number of epochs.
devices – Devices this component will live on.
logger – Any
logging.Logger
instance.seed – Random seed to reproduce this training.
finetune –
True
to load fromsave_dir
instead of creating a randomly initialized component.str
to specify a differentsave_dir
to load from.eval_trn – Evaluate training set after each update. This can slow down the training but provides a quick diagnostic for debugging.
_device_placeholder –
True
to create a placeholder tensor which triggers PyTorch to occupy devices so other components won’t take these devices as first choices.**kwargs – Hyperparameters used by sub-classes.
- Returns
Any results sub-classes would like to return. Usually the best metrics on training set.
-
fit_dataloader
(trn: torch.utils.data.dataloader.DataLoader, criterion, optimizer, metric, logger: logging.Logger, **kwargs)[source]¶ Fit onto a dataloader.
- Parameters
trn – Training set.
criterion – Loss function.
optimizer – Optimizer.
metric – Metric(s).
logger – Logger for reporting progress.
**kwargs – Other hyper-parameters passed from sub-class.
-
predict
(data: Union[str, List[str]], batch_size: int = None, **kwargs)[source]¶ Predict on data fed by user. Users shall avoid directly call this method since it is not guarded with
torch.no_grad
and will introduces unnecessary gradient computation. Use__call__
instead.- Parameters
data – Sentences or tokens.
batch_size – Decoding batch size.
**kwargs – Used in sub-classes.