diff --git a/README.md b/README.md index 9fa7f83485a966182ba3834db26fea413d38d618..0026d62607e2cbb944d825622d46ff1186d8fe58 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ EN|[CN](README.zh.md) [MindX SDK](https://www.hiascend.com/software/mindx-sdk) is a software development kit (SDK) launched by Huawei, offering simple and easy-to-use, high-performance APIs and tools. It includes multiple SDKs such as mxVision (visual analysis), mxRAG (knowledge enhancement), mxIndex (feature retrieval), and mxRec (search recommendation), aiding the Ascend AI processor in empowering various application scenarios. -To help developers quickly master the use of mxVision and mxRAG interfaces and rapidly implement business functions, this code repository (mxSdkReferenceApps) provides various reference samples developed based on mxVision and mxRAG. Users can select the appropriate sample code according to their needs. +To help developers quickly master the use of mxVision, mxRAG and mxIndex interfaces and rapidly implement business functions, this code repository (mxSdkReferenceApps) provides various reference samples developed based on mxVision, mxRAG and mxIndex. Users can select the appropriate sample code according to their needs. ## Main Directory Structure and Description | 目录 | 说明 | |---|-----------------------------------------------| @@ -12,6 +12,7 @@ To help developers quickly master the use of mxVision and mxRAG interfaces and r | [mxVision](./mxVision) | mxVision official sample directory | | [tutorials](./tutorials) | mxVision official tutorials directory | | [mxRAG](./mxRAG) | mxRAG offical sample directory | +| [mxIndex](./mxIndex) | mxIndex offical sample directory | ## Related Websites diff --git a/README.zh.md b/README.zh.md index 2db93081f20f19dd1c488b4d99a8b7fc261186ef..bfe7f2cbb760a044af23a287b8f7ed2ad0d5879e 100644 --- a/README.zh.md +++ b/README.zh.md @@ -3,7 +3,7 @@ [MindX SDK](https://www.hiascend.com/software/mindx-sdk) 是华为推出的软件开发套件(SDK),提供极简易用、高性能的API和工具,包含mxVision(视觉分析)、mxRAG(知识增强)、mxIndex(特征检索)、mxRec(搜索推荐)等多个SDK,助力昇腾AI处理器赋能各应用场景。 -为助力开发者快速掌握mxVision和mxRAG接口的使用、快速实现业务功能,本代码仓(mxSdkReferenceApps)提供了基于mxVision和mxRAG开发的各类参考样例。用户可根据自身需求选择相应案例代码。 +为助力开发者快速掌握mxVision,mxRAG接口和mxIndex接口的使用、快速实现业务功能,本代码仓(mxSdkReferenceApps)提供了基于mxVision, mxRAG和mxIndex开发的各类参考样例。用户可根据自身需求选择相应案例代码。 @@ -16,6 +16,7 @@ | [mxVision](./mxVision) | mxVision官方应用样例目录 | | [tutorials](./tutorials) | mxVision官方开发样例和文档参考工程目录 | | [mxRAG](./mxRAG) | mxRAG参考样例目录 | +| [mxIndex](./mxIndex) | mxIndex参考样例目录 | ## 相关网站 diff --git a/mxIndex/README.md b/mxIndex/README.md index 30c00f358e7d215c9eacaf49bde5cfb67f6b3bed..6a96fda60f02bd74ce2c5fd1c09282ea9f66e6d9 100644 --- a/mxIndex/README.md +++ b/mxIndex/README.md @@ -3,9 +3,16 @@ #### 介绍 **本仓库提供了昇腾MindX SDK index组件实现的几种常见检索算法的demo** -**master分支**对应版本mxIndex 6.0.RC2、mxIndex 6.0.RC1,依赖faiss版本为1.7.4 +#### 版本配套表 +| MindX SDK版本 | mxIndex版本 | CANN版本 | HDK版本 | 硬件形态 | +| -------------- | ------------ | -------- | -------- | --------- | +| master | 6.0.RC3 | 8.0.RC3 | 24.1.RC2 | Atlas推理系列产品 Atlas200/300/500 800I A2推理产品 | -**mxIndex-faiss1.7.1分支**对应版本mxIndex 5.0.0、mxIndex 5.0.1,依赖faiss版本为1.7.1 +之前版本请参见:https://gitee.com/ascend/ascend-referenceapps/tree/master/mxIndex_samples + +master分支对应版本mxIndex 6.0.RC2、mxIndex 6.0.RC1,依赖faiss版本为1.7.4 + +mxIndex-faiss1.7.1分支对应版本mxIndex 5.0.0、mxIndex 5.0.1,依赖faiss版本为1.7.1 #### 关于MindX SDK 更多信息 请关注昇腾社区[MindX SDK](https://www.hiascend.com/zh/software/mindx-sdk)的最新版本