potsawee commited on
Commit
fbac9fe
1 Parent(s): efbd009

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -0
README.md CHANGED
@@ -51,6 +51,19 @@ response = model.generate(
51
  )
52
  print(response)
53
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
54
 
55
  ## Evaluation Results
56
 
 
51
  )
52
  print(response)
53
  ```
54
+ **Generation Parameters**:
55
+ - wav_path (`str`) -- Path to the audio file (format = wav, flac, mp3, etc as long as `soundfile.read` supports)
56
+ - prompt (`str`) -- Text input to the model
57
+ - prompt_pattern (`str`) -- Chat template that is augmented with special tokens, and it must be set the same as one during training
58
+ - max_length (`int`, *optional*, defaults to 150)
59
+ - num_beams (`int`, *optional*, defaults to 4)
60
+ - do_sample (`bool`, *optional*, defaults to True)
61
+ - min_length (`int`, *optional*, defaults to 1)
62
+ - top_p (`float`, *optional*, defaults to 0.9)
63
+ - repetition_penalty (`float`, *optional*, defaults to 1.0),
64
+ - length_penalty (`float`, *optional*, defaults to 1.0),
65
+ - temperature (`float`, *optional*, defaults to 1.0),
66
+ - streamer (`TextIteratorStreamer`, *optional*, defaults to `None`) -- this allows streaming output
67
 
68
  ## Evaluation Results
69