doc: fix typos in design docs (#32885)

Signed-off-by: shaoting-huang <shaoting.huang@zilliz.com>
This commit is contained in:
shaoting-huang 2024-05-09 15:43:30 +08:00 committed by GitHub
parent acb0417a9f
commit ca0cf9b3b1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 7 additions and 7 deletions

View File

@ -33,7 +33,7 @@ DataNode discovers DataCoord and RootCoord, in *HEALTHY* and *IDLE* state.
### 3. Flowgraph Recovery ### 3. Flowgraph Recovery
The detailed design can be found at [datanode flowgraph recovery design](datanode_flowgraph_recovery_design_0604_2021.md). The detailed design can be found at [datanode flowgraph recovery design](20210604-datanode_flowgraph_recovery_design.md).
After DataNode subscribes to a stateful vchannel, DataNode starts to work, or more specifically, flowgraph starts to work. After DataNode subscribes to a stateful vchannel, DataNode starts to work, or more specifically, flowgraph starts to work.

View File

@ -87,7 +87,7 @@ The ID is stored in a key-value pair on etcd. The key is metaRootPath + "/sessio
###### Interface ###### Interface
````go ```go
const ( const (
DefaultServiceRoot = "session/" DefaultServiceRoot = "session/"
DefaultIDKey = "id" DefaultIDKey = "id"
@ -130,11 +130,11 @@ func (s *Session) GetSessions(prefix string) (map[string]*Session, int64, error)
// If a server up, an event will be added to channel with eventType SessionAddType. // If a server up, an event will be added to channel with eventType SessionAddType.
// If a server down, an event will be added to channel with eventType SessionDelType. // If a server down, an event will be added to channel with eventType SessionDelType.
func (s *Session) WatchServices(prefix string, revision int64) (eventChannel <-chan *SessionEvent) {} func (s *Session) WatchServices(prefix string, revision int64) (eventChannel <-chan *SessionEvent) {}
```
#### A.3 Global Parameter Table #### A.3 Global Parameter Table
``` go ```go
type BaseTable struct { type BaseTable struct {
params *memkv.MemoryKV params *memkv.MemoryKV
} }
@ -154,7 +154,7 @@ func (gp *BaseTable) WriteNodeIDList() []UniqueID
func (gp *BaseTable) DataNodeIDList() []UniqueID func (gp *BaseTable) DataNodeIDList() []UniqueID
func (gp *BaseTable) ProxyIDList() []UniqueID func (gp *BaseTable) ProxyIDList() []UniqueID
func (gp *BaseTable) QueryNodeIDList() []UniqueID func (gp *BaseTable) QueryNodeIDList() []UniqueID
```` ```
- _LoadYaml(filePath string)_ turns a YAML file into multiple key-value pairs. For example, given the following YAML - _LoadYaml(filePath string)_ turns a YAML file into multiple key-value pairs. For example, given the following YAML

View File

@ -55,11 +55,11 @@ enum DataType {
# Intro to Index # Intro to Index
For more detailed information about indexes, please refer to [Milvus documentation index chapter.](https://milvus.io/docs/v2.0.0/index.md) For more detailed information about indexes, please refer to [Milvus documentation index chapter.](https://milvus.io/docs/index.md)
To learn how to choose an appropriate index for your application scenarios, please read [How to Select an Index in Milvus](https://medium.com/@milvusio/how-to-choose-an-index-in-milvus-4f3d15259212). To learn how to choose an appropriate index for your application scenarios, please read [How to Select an Index in Milvus](https://medium.com/@milvusio/how-to-choose-an-index-in-milvus-4f3d15259212).
To learn how to choose an appropriate index for a metric, see [Distance Metrics](https://www.milvus.io/docs/v2.0.0/metric.md). To learn how to choose an appropriate index for a metric, see [Similarity Metrics](https://milvus.io/docs/metric.md).
Different index types use different index params in construction and query. All index params are represented by the structure of the map. This doc shows the map code in python. Different index types use different index params in construction and query. All index params are represented by the structure of the map. This doc shows the map code in python.