Skip to content

Commit

Permalink
Merge branch 'main' into update-myscale
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruv-anand-aintech authored Jan 15, 2024
2 parents 6820810 + 818e058 commit 97b540f
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 10 deletions.
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE/vdb-table_pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ labels: 'vdb comparison'

## Checklist before requesting a review
- [ ] I have followed the [contribution guidelines](https://github.com/superlinked/VectorHub/tree/main/docs/tools/vdb_table)
- [ ] I have provided a reference for each attribute for which I'm adding a "support" claim.
6 changes: 5 additions & 1 deletion docs/tools/vdb_table/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,11 @@ tools/


Attributes inside vendorX.json has the following properties
- `support`: Whose values can be `[ "", "none", "partial", "full" ]` indicating on confidence levels, for that attribute support.
- `support`: Whose values can be `[ "", "none", "partial", "full" ]` indicating on confidence levels, for that attribute support. NOTE: Each change where a "support" claim is being added MUST include either i) a reference to documentation, ii) an example of the functionality being described, or iii) a link to the actual code implementing the specific functionality.
- `""` means the cell will be blank.
- `"none"` means the cell will have a ❌.
- `"partial"` means the cell will have a 🟨.
- `"full"` means the cell will have a ✅.
- `value`: `license` and `dev_languages` have this property to support values about license details and languages (as a list).
- `source_url`: To provide documentation links, or evidence supporting the attribute values. It is shown as the 'external link' button in the cell.
- `comment`: Any other useful information that will be shown on hover and with the info icon.
Expand Down
16 changes: 8 additions & 8 deletions docs/tools/vdb_table/data/txtai.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "txtai",
"links": {
"docs": "https://neuml.github.io/txtai/",
"github": "https://neuml.github.io/txtai/",
"github": "https://github.com/neuml/txtai",
"website": "https://neuml.github.io/txtai/",
"vendor_discussion": "https://github.com/superlinked/VectorHub/discussions/86",
"poc_github": "https://github.com/davidmezzetti",
Expand All @@ -25,7 +25,7 @@
"source_url": "",
"comment": ""
},
"github_stars": 5500,
"github_stars": 5972,
"vector_launch_year": 2020,
"metadata_filter": {
"support": "full",
Expand Down Expand Up @@ -113,19 +113,19 @@
"comment": ""
},
"in_process": {
"support": "none",
"support": "full",
"source_url": "",
"comment": ""
"comment": "txtai embeddings indexes can be loaded and run directly in a Python application"
},
"multi_tenancy": {
"support": "",
"source_url": "",
"comment": ""
},
"disk_index": {
"support": "",
"source_url": "",
"comment": ""
"support": "partial",
"source_url": "https://neuml.github.io/txtai/embeddings/configuration/ann/#faiss",
"comment": "txtai embeddings indexes support on disk operations via mmap"
},
"ephemeral": {
"support": "full",
Expand All @@ -149,4 +149,4 @@
"source_url": "",
"comment": ""
}
}
}
2 changes: 1 addition & 1 deletion docs/tools/vdb_table/vendor.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"pricing": {"allOf": [{"$ref": "#/$defs/stringWithSource"}], "$comment": "Ops | Pricing | The pricing models very widely, so this field is unstructured and ideally points to a pricing page." },
"in_process": {"allOf": [{"$ref": "#/$defs/featureWithSource"}], "$comment": "Ops | In-process | Ability to run embedded within the application process, which leads to a simpler deployment and management in situations when the whole workload fits into one machine." },
"multi_tenancy": {"allOf": [{"$ref": "#/$defs/featureWithSource"}], "$comment": "Ops | Multi-Tenant | Multi-tenancy - the ability to store multiple isolated indexes within one database instance." },
"disk_index": {"allOf": [{"$ref": "#/$defs/featureWithSource"}], "$comment": "Ops | Disk Index | Ability to store the vector index state on disk." },
"disk_index": {"allOf": [{"$ref": "#/$defs/featureWithSource"}], "$comment": "Ops | Disk Index | The vector search index can be held on disk while in use, as opposed to holding it in RAM, which makes the management of large indices more affordable." },
"ephemeral": {"allOf": [{"$ref": "#/$defs/featureWithSource"}], "$comment": "Ops | Ephemeral Index | Ephemeral index support without a server." },
"sharding": {"allOf": [{"$ref": "#/$defs/featureWithSource"}], "$comment": "Ops | Sharding | The search index is sharded across multiple machines." },
"doc_size": {"allOf": [{"$ref": "#/$defs/bytesWithSource"}], "$comment": "Ops | Document Size | Maximum size of a stored document." },
Expand Down

0 comments on commit 97b540f

Please sign in to comment.