docs: fix output rail doc #1159
Conversation
| @@ -185,9 +185,11 @@ You can enable streaming to provide asynchronous responses and reduce the time t | |||
| streaming: | |||
| chunk_size: 200 | |||
| context_size: 50 | |||
| enabled: True | |||
There was a problem hiding this comment.
Do you mind making this the first field underneath streaming:?
|
|
||
| streaming: True | ||
| ``` | ||
| Note that, the `enabled: True` filed is needed to enable streaming output rails while `streaming: True` is needed to enable streaming generation. |
There was a problem hiding this comment.
Please remove "Note that," and start with "The enabled...." Please also add a line above for ease of review by future maintainers. (nit: typo for field.)
@Pouyanpi, is the description for the top-level streaming field accurate? (I wish that I knew better myself.)
| @@ -689,6 +689,7 @@ rails: | |||
| chunk_size: 200 | |||
| context_size: 50 | |||
| stream_first: True | |||
| enabled: True | |||
There was a problem hiding this comment.
As with the previous comment, do you mind making this the first field beneath "streaming:"?
| @@ -742,6 +743,11 @@ The following table describes the subfields for the `streaming` field: | |||
| By default, the toolkit streams the chunks as soon as possible and before applying output rails to them. | |||
|
|
|||
| - `True` | |||
|
|
|||
| * - streaming.enabled | |||
| - When set to True enable the execution of the output rails in streaming mode. | |||
There was a problem hiding this comment.
Do you mind putting this row in alphabetical order?
Thanks for following the "When set..." pattern. Do you mind enclosing True in backticks (True) and following with a comma? Maybe also revise to "When set to True, the toolkit executes output rails in streaming mode."
Documentation preview |
Description
Fix some issues on output streaming rails documentation.
Specifically the
streaming.enabledfield was missingRelated Issue(s)
I haven't opened a proper issue for that
Checklist