.\" Text automatically generated by txt2man
.TH mlpack_hmm_generate 1 "11 January 2024" "mlpack-4.3.0" "User Commands"
.SH NAME
\fBmlpack_hmm_generate \fP- hidden markov model (hmm) sequence generator
.SH SYNOPSIS
.nf
.fam C
 \fBmlpack_hmm_generate\fP \fB-l\fP \fIint\fP \fB-m\fP \fIunknown\fP [\fB-s\fP \fIint\fP] [\fB-t\fP \fIint\fP] [\fB-V\fP \fIbool\fP] [\fB-o\fP \fIunknown\fP] [\fB-S\fP \fIunknown\fP] [\fB-h\fP \fB-v\fP] 
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION


This utility takes an already-trained HMM, specified as the '\fB--model_file\fP
(\fB-m\fP)' parameter, and generates a random observation sequence and hidden state
sequence based on its parameters. The observation sequence may be saved with
the '\fB--output_file\fP (\fB-o\fP)' output parameter, and the internal state sequence
may be saved with the '\fB--state_file\fP (\fB-S\fP)' output parameter.
.PP
The state to start the sequence in may be specified with the '\fB--start_state\fP
(\fB-t\fP)' parameter.
.PP
For example, to generate a sequence of length 150 from the HMM 'hmm.bin' and
save the observation sequence to 'observations.csv' and the hidden state
sequence to 'states.csv', the following command may be used: 
.PP
$ \fBmlpack_hmm_generate\fP \fB--model_file\fP hmm.bin \fB--length\fP 150 \fB--output_file\fP
observations.csv \fB--state_file\fP states.csv
.RE
.PP

.SH REQUIRED INPUT OPTIONS 

.TP
.B
\fB--length\fP (\fB-l\fP) [\fIint\fP]
Length of sequence to generate. 
.TP
.B
\fB--model_file\fP (\fB-m\fP) [\fIunknown\fP]
Trained HMM to generate sequences with.  
.SH OPTIONAL INPUT OPTIONS 

.TP
.B
\fB--help\fP (\fB-h\fP) [\fIbool\fP]
Default help info. 
.TP
.B
\fB--info\fP [string]
Print help on a specific option. Default value ''. 
.TP
.B
\fB--seed\fP (\fB-s\fP) [\fIint\fP]
Random seed. If 0, 'std::time(NULL)' is used.  Default value 0. 
.TP
.B
\fB--start_state\fP (\fB-t\fP) [\fIint\fP]
Starting state of sequence. Default value 0. 
.TP
.B
\fB--verbose\fP (\fB-v\fP) [\fIbool\fP]
Display informational messages and the full list of parameters and timers at the end of execution. 
.TP
.B
\fB--version\fP (\fB-V\fP) [\fIbool\fP]
Display the version of mlpack.  
.SH OPTIONAL OUTPUT OPTIONS 

\fB--output_file\fP (\fB-o\fP) [\fIunknown\fP] Matrix to save observation sequence to. 
.TP
.B
\fB--state_file\fP (\fB-S\fP) [\fIunknown\fP]
Matrix to save hidden state sequence to.
.SH ADDITIONAL INFORMATION

For further information, including relevant papers, citations, and theory,
consult the documentation found at http://www.mlpack.org or included with your
distribution of mlpack.