potsawee commited on
Commit
bcce7a2
1 Parent(s): 4041e77

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -4
README.md CHANGED
@@ -58,7 +58,6 @@ response = model.generate(
58
  num_beams=1,
59
  # temperature=0.4,
60
  # top_p=0.9,
61
- # streamer=streamer # supports TextIteratorStreamer
62
  )
63
  print(response)
64
  ```
@@ -66,15 +65,15 @@ print(response)
66
  - wav_path (`str`) -- Path to the audio file (format = wav, flac, mp3, etc as long as `soundfile.read` supports)
67
  - prompt (`str`) -- Text input to the model
68
  - prompt_pattern (`str`) -- Chat template that is augmented with special tokens, and it must be set the same as one during training
69
- - max_length (`int`, *optional*, defaults to 150)
70
  - num_beams (`int`, *optional*, defaults to 4)
71
  - do_sample (`bool`, *optional*, defaults to True)
72
- - min_length (`int`, *optional*, defaults to 1)
73
  - top_p (`float`, *optional*, defaults to 0.9)
74
  - repetition_penalty (`float`, *optional*, defaults to 1.0),
75
  - length_penalty (`float`, *optional*, defaults to 1.0),
76
  - temperature (`float`, *optional*, defaults to 1.0),
77
- - streamer (`TextIteratorStreamer`, *optional*, defaults to `None`) -- this allows streaming output
 
78
 
79
  ## Evaluation Results
80
  More information is provided in our [technical report](https://arxiv.org/abs/2409.10999).
 
58
  num_beams=1,
59
  # temperature=0.4,
60
  # top_p=0.9,
 
61
  )
62
  print(response)
63
  ```
 
65
  - wav_path (`str`) -- Path to the audio file (format = wav, flac, mp3, etc as long as `soundfile.read` supports)
66
  - prompt (`str`) -- Text input to the model
67
  - prompt_pattern (`str`) -- Chat template that is augmented with special tokens, and it must be set the same as one during training
68
+ - max_new_tokens (`int`, *optional*, defaults to 1024)
69
  - num_beams (`int`, *optional*, defaults to 4)
70
  - do_sample (`bool`, *optional*, defaults to True)
 
71
  - top_p (`float`, *optional*, defaults to 0.9)
72
  - repetition_penalty (`float`, *optional*, defaults to 1.0),
73
  - length_penalty (`float`, *optional*, defaults to 1.0),
74
  - temperature (`float`, *optional*, defaults to 1.0),
75
+
76
+ This is also `model.generate_stream()` for streaming generation. Please refer to `modeling_typhoonaudio.py` for this function.
77
 
78
  ## Evaluation Results
79
  More information is provided in our [technical report](https://arxiv.org/abs/2409.10999).