Skip to content

Commit 79c2be4

Browse files
fixes typos and minor reformatting issues
1 parent 16d6d59 commit 79c2be4

File tree

1 file changed

+7
-4
lines changed
  • docs/proposals/XXXX-pluggable-bbr-framework

1 file changed

+7
-4
lines changed

docs/proposals/XXXX-pluggable-bbr-framework/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,17 @@ In addition, a `PluginsChain` interface is defined to define an order of plugin
5151

5252
Depending on a `BBRPlugin` functionality and implementation, the plugin might require full or selective body parsing. To save the parsing overhead, if there is at least one `BBRPlugin` in the `PluginsChain` that requires full body parsing, the parsing is performed only once into a shared official appropriate `openai-go` struct (either `openai.CompletionNewParams` or `openai.ChatCompletionNewParams` depending on the request endpoint). This struct is shared for read-only to all plugins in the chain. Each `BBRplugin` receives the shared struct by value. If a plugin needs to mutate the body, in the initial implementation, it MUST work on its own copy, and the a mutated body is returned separately by each plugiin.
5353

54-
### Suggested BBR Pluggable Framework Interfaces
54+
### Suggested Components
5555

5656
The sketch of the proposed framework is shown in the figure below.
5757
<img src="./images/pluggable-framework-architecture-sketch.png" alt="Components of the proposed framework" width="1000" />
5858

59+
60+
The following figure shows a sequence diagram that illustrates the components interaction
61+
<img src="./images/bbr-pluggable-framework-sequence-diagram.png" alt="Sequence diagram" width="1000" />
62+
63+
### Suggested BBR Pluggable Framework Interfaces
64+
5965
```go
6066
//Base BBRPlugin interface
6167
type BBRPlugin interface {
@@ -141,9 +147,6 @@ var SupportedInterfaces = map[string][]string{
141147
}
142148
```
143149

144-
The figure below shows a sequence diagram that illustrates the components interaction
145-
<img src="./images/bbr-pluggable-framework-sequence.png" alt="Sequence diagram" width="1000" />
146-
147150
### Implementation Phases
148151

149152
The pluggable framework will be implemented iteratively over several phases.

0 commit comments

Comments
 (0)