Skip to content

Commit 7d6e4f0

Browse files
authored
Change "client" to "SDK" in README (#382)
## 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.
1 parent 3c1e4e0 commit 7d6e4f0

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Pinecone Python Client
1+
# Pinecone Python SDK
22
![License](https://img.shields.io/github/license/pinecone-io/pinecone-python-client?color=orange) [![CI](https://github.com/pinecone-io/pinecone-python-client/actions/workflows/pr.yaml/badge.svg)](https://github.com/pinecone-io/pinecone-python-client/actions/workflows/pr.yaml)
33

4-
The official Pinecone Python client.
4+
The official Pinecone Python SDK.
55

6-
For more information, see the docs at https://www.pinecone.io/docs/
6+
For more information, see the docs at https://docs.pinecone.io
77

88
## Documentation
99

1010
- [**Reference Documentation**](https://sdk.pinecone.io/python/index.html)
1111

12-
### Upgrading your client
12+
### Upgrading the SDK
1313

1414
#### Upgrading from `4.x` to `5.x`
1515

@@ -21,21 +21,21 @@ It is no longer necessary to install a separate plugin, `pinecone-plugin-inferen
2121

2222
- **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).
2323

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.
2525

2626
### Example code
2727

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.
2929

3030
## Prerequisites
3131

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.
3333

3434
## Installation
3535

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.
3737

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).
3939

4040
### Installing with pip
4141

@@ -104,7 +104,7 @@ pc = Pinecone(api_key=os.environ.get('CUSTOM_VAR'))
104104
### Proxy configuration
105105

106106
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.
108108

109109
Here is a basic example:
110110

@@ -136,7 +136,7 @@ pc.list_indexes()
136136

137137
### Using proxies with self-signed certificates
138138

139-
By default the Pinecone Python client will perform SSL certificate verification
139+
By default the Pinecone Python SDK will perform SSL certificate verification
140140
using the CA bundle maintained by Mozilla in the [certifi](https://pypi.org/project/certifi/) package.
141141

142142
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()
178178

179179
### Working with GRPC (for improved performance)
180180

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.
182182

183183
```python
184184
import os
185185
from pinecone.grpc import PineconeGRPC
186186

187187
pc = PineconeGRPC(api_key=os.environ.get('PINECONE_API_KEY'))
188188

189-
# From here on, everything is identical to the REST-based client.
189+
# From here on, everything is identical to the REST-based SDK.
190190
index = pc.Index(host='my-index-8833ca1.svc.us-east1-gcp.pinecone.io')
191191

192192
index.upsert(vectors=[])
@@ -585,4 +585,4 @@ query_embeddings = pc.inference.embed(
585585

586586
# Contributing
587587

588-
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

Comments
 (0)