You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Problem
We are inconsistent in how we refer to our client libraries.
## Solution
As we mostly refer to our "SDKs" rather than our "clients", we've
updated our docs to prefer "SDK". This PR makes equivalent updates to
the Python README.
Addresses: https://app.asana.com/0/1206419570114940/1207978475519546/f
## Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update
- [ ] Infrastructure change (CI configs, etc)
- [x] Non-code change (docs, etc)
- [ ] None of the above: (explain here)
## Test Plan
Describe specific steps for validating this change.
@@ -21,21 +21,21 @@ It is no longer necessary to install a separate plugin, `pinecone-plugin-inferen
21
21
22
22
-**Upgrading to `4.x`** : For this upgrade you are unlikely to be impacted by breaking changes unless you are using the `grpc` extras (see install steps below). Read full details in these [v4 Release Notes](https://github.com/pinecone-io/pinecone-python-client/releases/tag/v4.0.0).
23
23
24
-
-**Upgrading to `3.x`**: Many things were changed in the v3 client to pave the way for Pinecone's new Serverless index offering. These changes are covered in detail in the [**v3 Migration Guide**](https://canyon-quilt-082.notion.site/Pinecone-Python-SDK-v3-0-0-Migration-Guide-056d3897d7634bf7be399676a4757c7b#a21aff70b403416ba352fd30e300bce3). Serverless indexes are only available in `3.x` release versions or greater.
24
+
-**Upgrading to `3.x`**: Many things were changed in the v3 SDK to pave the way for Pinecone's new Serverless index offering. These changes are covered in detail in the [**v3 Migration Guide**](https://canyon-quilt-082.notion.site/Pinecone-Python-SDK-v3-0-0-Migration-Guide-056d3897d7634bf7be399676a4757c7b#a21aff70b403416ba352fd30e300bce3). Serverless indexes are only available in `3.x` release versions or greater.
25
25
26
26
### Example code
27
27
28
-
Many of the brief examples shown in this README are using very small vectors to keep the documentation concise, but most real world usage will involve much larger embedding vectors. To see some more realistic examples of how this client can be used, explore some of our many Jupyter notebooks in the [examples](https://github.com/pinecone-io/examples) repository.
28
+
Many of the brief examples shown in this README are using very small vectors to keep the documentation concise, but most real world usage will involve much larger embedding vectors. To see some more realistic examples of how this SDK can be used, explore some of our many Jupyter notebooks in the [examples](https://github.com/pinecone-io/examples) repository.
29
29
30
30
## Prerequisites
31
31
32
-
The Pinecone Python client is compatible with Python 3.8 and greater.
32
+
The Pinecone Python SDK is compatible with Python 3.8 and greater.
33
33
34
34
## Installation
35
35
36
-
There are two flavors of the Pinecone python client. The default client installed from PyPI as `pinecone-client` has a minimal set of dependencies and interacts with Pinecone via HTTP requests.
36
+
There are two flavors of the Pinecone Python SDK. The default flavor installed from PyPI as `pinecone-client` has a minimal set of dependencies and interacts with Pinecone via HTTP requests.
37
37
38
-
If you are aiming to maximimize performance, you can install additional gRPC dependencies to access an alternate client implementation that relies on gRPC for data operations. See the guide on [tuning performance](https://docs.pinecone.io/docs/performance-tuning).
38
+
If you are aiming to maximimize performance, you can install additional gRPC dependencies to access an alternate SDK implementation that relies on gRPC for data operations. See the guide on [tuning performance](https://docs.pinecone.io/docs/performance-tuning).
39
39
40
40
### Installing with pip
41
41
@@ -104,7 +104,7 @@ pc = Pinecone(api_key=os.environ.get('CUSTOM_VAR'))
104
104
### Proxy configuration
105
105
106
106
If your network setup requires you to interact with Pinecone via a proxy, you will need
107
-
to pass additional configuration using optional keyword parameters. These optional parameters are forwarded to `urllib3`, which is the underlying library currently used by the Pinecone client to make HTTP requests. You may find it helpful to refer to the [urllib3 documentation on working with proxies](https://urllib3.readthedocs.io/en/stable/advanced-usage.html#http-and-https-proxies) while troubleshooting these settings.
107
+
to pass additional configuration using optional keyword parameters. These optional parameters are forwarded to `urllib3`, which is the underlying library currently used by the Pinecone SDK to make HTTP requests. You may find it helpful to refer to the [urllib3 documentation on working with proxies](https://urllib3.readthedocs.io/en/stable/advanced-usage.html#http-and-https-proxies) while troubleshooting these settings.
108
108
109
109
Here is a basic example:
110
110
@@ -136,7 +136,7 @@ pc.list_indexes()
136
136
137
137
### Using proxies with self-signed certificates
138
138
139
-
By default the Pinecone Python client will perform SSL certificate verification
139
+
By default the Pinecone Python SDK will perform SSL certificate verification
140
140
using the CA bundle maintained by Mozilla in the [certifi](https://pypi.org/project/certifi/) package.
141
141
142
142
If your proxy server is using a self-signed certificate, you will need to pass the path to the certificate in PEM format using the `ssl_ca_certs` parameter.
@@ -178,15 +178,15 @@ pc.list_indexes()
178
178
179
179
### Working with GRPC (for improved performance)
180
180
181
-
If you've followed instructions above to install with optional `grpc` extras, you can unlock some performance improvements by working with an alternative version of the client imported from the `pinecone.grpc` subpackage.
181
+
If you've followed instructions above to install with optional `grpc` extras, you can unlock some performance improvements by working with an alternative version of the SDK imported from the `pinecone.grpc` subpackage.
182
182
183
183
```python
184
184
import os
185
185
from pinecone.grpc import PineconeGRPC
186
186
187
187
pc = PineconeGRPC(api_key=os.environ.get('PINECONE_API_KEY'))
188
188
189
-
# From here on, everything is identical to the REST-based client.
189
+
# From here on, everything is identical to the REST-based SDK.
190
190
index = pc.Index(host='my-index-8833ca1.svc.us-east1-gcp.pinecone.io')
If you'd like to make a contribution, or get setup locally to develop the Pinecone python client, please see our [contributing guide](https://github.com/pinecone-io/pinecone-python-client/blob/main/CONTRIBUTING.md)
588
+
If you'd like to make a contribution, or get setup locally to develop the Pinecone Python SDK, please see our [contributing guide](https://github.com/pinecone-io/pinecone-python-client/blob/main/CONTRIBUTING.md)
0 commit comments