Browse Source

fix markdown

Signed-off-by: sahuang <xiaohai.xu@zilliz.com>
sahuang 5 years ago
parent
commit
f9d05269f2
2 changed files with 33 additions and 24 deletions
  1. 30 23
      CHANGELOG.md
  2. 3 1
      README.md

+ 30 - 23
CHANGELOG.md

@@ -3,26 +3,34 @@
 ## milvus-sdk-java 0.8.0 (2020-05-15)
 ## milvus-sdk-java 0.8.0 (2020-05-15)
 
 
 ### Feature
 ### Feature
+
 ---
 ---
-- \#93 - Update Java SDK APIs for getVectorByID, collectionInfo and hasPartition
+
+- \#93 - Add/Improve getVectorByID, collectionInfo and hasPartition API
 - \#2295 - Rename sdk interfaces
 - \#2295 - Rename sdk interfaces
 
 
 ## milvus-sdk-java 0.7.0 (2020-04-15)
 ## milvus-sdk-java 0.7.0 (2020-04-15)
 
 
 ### Feature
 ### Feature
+
 ---
 ---
+
 - \#261 - Integrate ANNOY into Milvus
 - \#261 - Integrate ANNOY into Milvus
 - \#1828 - Add searchAsync / createIndexAsync / insertAsync / flushAsync / compactAsync API
 - \#1828 - Add searchAsync / createIndexAsync / insertAsync / flushAsync / compactAsync API
 
 
 ## milvus-sdk-java 0.6.0 (2020-03-31)
 ## milvus-sdk-java 0.6.0 (2020-03-31)
 
 
 ### Bug
 ### Bug
+
 ---
 ---
+
 - \#1641 - Fix incorrect error logging message
 - \#1641 - Fix incorrect error logging message
 - \#1642 - Fix compilation error of ByteBuffer
 - \#1642 - Fix compilation error of ByteBuffer
 
 
 ### Feature
 ### Feature
+
 ---
 ---
+
 - \#1603 - Add binary metrics: Substructure & Superstructure
 - \#1603 - Add binary metrics: Substructure & Superstructure
 
 
 ## milvus-sdk-java 0.5.0 (2020-03-11)
 ## milvus-sdk-java 0.5.0 (2020-03-11)
@@ -30,72 +38,67 @@
 ## milvus-sdk-java 0.4.1 (2019-12-16)
 ## milvus-sdk-java 0.4.1 (2019-12-16)
 
 
 ### Bug
 ### Bug
+
 ---
 ---
+
 - \#78 - Partition tag not working when searching
 - \#78 - Partition tag not working when searching
 
 
 ## milvus-sdk-java 0.4.0 (2019-12-7)
 ## milvus-sdk-java 0.4.0 (2019-12-7)
 
 
 ### Bug
 ### Bug
+
 ---
 ---
+
 - \#74 - Partition tag not working when inserting
 - \#74 - Partition tag not working when inserting
 
 
 ### Improvement
 ### Improvement
+
 ---
 ---
+
 - \#61 - Add partition
 - \#61 - Add partition
 - \#70 - Add IndexType IVF_PQ
 - \#70 - Add IndexType IVF_PQ
 - \#72 - Add more getters in ShowPartitionResponse
 - \#72 - Add more getters in ShowPartitionResponse
 - \#73 - Add @Deprecated for DateRanges in SearchParam
 - \#73 - Add @Deprecated for DateRanges in SearchParam
 
 
-### Feature
----
-
-### Task
----
-
 ## milvus-sdk-java 0.3.0 (2019-11-13)
 ## milvus-sdk-java 0.3.0 (2019-11-13)
 
 
 ### Bug
 ### Bug
+
 ---
 ---
+
 - \#64 - Search failed with exception if search result is empty
 - \#64 - Search failed with exception if search result is empty
 
 
 ### Improvement
 ### Improvement
+
 ---
 ---
+
 - \#56 - Add keepalive and idleTimeout settings
 - \#56 - Add keepalive and idleTimeout settings
 - \#57 - add ok() in other types of Response
 - \#57 - add ok() in other types of Response
 - \#62 - Change GRPC proto (and related code) to increase search result's transmission speed
 - \#62 - Change GRPC proto (and related code) to increase search result's transmission speed
 - \#63 - Make some functions and constructors package-private if necessary
 - \#63 - Make some functions and constructors package-private if necessary
 
 
-### Feature
----
-
-### Task
----
-
 ## milvus-sdk-java 0.2.2 (2019-11-4)
 ## milvus-sdk-java 0.2.2 (2019-11-4)
 
 
-### Bug
----
-
 ### Improvement
 ### Improvement
+
 ---
 ---
+
 - \#49 - Add waitTime option in ConnectParam
 - \#49 - Add waitTime option in ConnectParam
 - \#51 - Change connect waitTime to timeout
 - \#51 - Change connect waitTime to timeout
 - \#52 - Change IVF_SQ8H to IVF_SQ8_H
 - \#52 - Change IVF_SQ8H to IVF_SQ8_H
 
 
-### Feature
----
-
-### Task
----
-
 ## milvus-sdk-java 0.2.0 (2019-10-21)
 ## milvus-sdk-java 0.2.0 (2019-10-21)
 
 
 ### Bug
 ### Bug
+
 ---
 ---
+
 - \#42 - fix search result validation
 - \#42 - fix search result validation
     
     
 ### Improvement
 ### Improvement
+
 ---
 ---
+
 - \#3 - Force channel to request connection in connect()  and some code cleanup
 - \#3 - Force channel to request connection in connect()  and some code cleanup
 - \#6 - Update pom & fix deleteByRange error message & update unittest
 - \#6 - Update pom & fix deleteByRange error message & update unittest
 - \#8 - change default timeout to 24 hour
 - \#8 - change default timeout to 24 hour
@@ -108,12 +111,16 @@
 - \#38 - Update examples
 - \#38 - Update examples
 - \#40 - Remove timeout parameter & Several API changes    
 - \#40 - Remove timeout parameter & Several API changes    
 
 
-### New Feature
+### Feature
+
 ---
 ---
+
 - \#16 - add IVF_SQ8_H index type
 - \#16 - add IVF_SQ8_H index type
 
 
 ### Task
 ### Task
+
 ---
 ---
+
 - \#1 - First implementation
 - \#1 - First implementation
 - \#21 - Add javadoc
 - \#21 - Add javadoc
 - \#23 - Format code with Google-java-style and add Apache 2.0 license header
 - \#23 - Format code with Google-java-style and add Apache 2.0 license header

+ 3 - 1
README.md

@@ -60,7 +60,9 @@ Please refer to [examples](https://github.com/milvus-io/milvus-sdk-java/tree/mas
     ```
     ```
     Exception in thread "main" java.lang.NoClassDefFoundError: org/slf4j/LoggerFactory
     Exception in thread "main" java.lang.NoClassDefFoundError: org/slf4j/LoggerFactory
     ```
     ```
-  This is because SLF4J jar file needs to be added into your application's classpath. To fix this issue, you can use **Apache Maven** or **Gradle**/**Grails** to download the SDK.
+  This is because SLF4J jar file needs to be added into your application's classpath.
+  
+  To fix this issue, you can use **Apache Maven** or **Gradle**/**Grails** to download the required jar files.
                                                                                                          
                                                                                                          
     - Apache Maven
     - Apache Maven