docs: Add a readme for the pgai docs. #307
Open
+3,397
−421
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cevian
requested changes
Dec 16, 2024
docs/README.md
Outdated
| Simplifies data storage and retrieval for AI apps. | ||
|
|
||
| - **Get started**: | ||
| * [Install pgai with Docker](/docs/install_docker.md): run pgai in a container environment. |
There was a problem hiding this comment.
these installation guides apply across vectorizer and model calling. They should be in a separate top-level install section
docs/README.md
Outdated
|
|
||
| - **Get started**: | ||
| * [Install pgai with Docker](/docs/install_docker.md): run pgai in a container environment. | ||
| * [Setup pgai with Anthropic](/docs/anthropic.md): configure pgai to connect to your Anthropic account. |
There was a problem hiding this comment.
can you just copy over the table we have on the front page? I think the table is easier to understand... unless we need this for SEO?
Co-authored-by: Matvey Arye <cevian@gmail.com> Signed-off-by: Iain Cox <iain@timescale.com>
cevian
approved these changes
Dec 19, 2024
The build started failing with the following error message:
```
Checking ./dist/pgai-0.3.0-py3-none-any.whl: ERROR InvalidDistribution: Metadata is missing required fields: Name,
Version.
Make sure the distribution includes the files where those fields are
specified, and is using a supported Metadata-Version: 1.0, 1.1, 1.2,
2.0, 2.1, 2.2, 2.3.
```
This error comes from `twine check dist/*`. It is caused by the fact
that `hatchling`, which we use to build wheels, released a new version
which bumped the `Metadata-Version` field to `2.4`, and twine/pkginfo
aren't able to process this version.
By pinning `hatchling` to 1.26.3, the previous release, we solve this
immediate problem, and avoid new breakage from future hatchling
releases.
We would like to support uv in an opt-in fashion. The `build.py install` now uses uv if it is available, otherwise falling back to pip. To use uv, we now install it in our dev containers.
We install the dependencies for an extension version in a specific path for that version alone. When one of our plpython3u functions is called, we set up the python path to include these dependencies. For the very first extension releases, we didn't do it this way. Instead, the dependencies were installed into the system python's path. As a result, we were inadvertently using _both_ packages installed for the system python, and the packages installed for the specific extension version. When the same package is installed in both, the system python version is chosen first. This breaks Python's assumptions about dependency resolution, and can break installed packages. This change removes the system python dependencies from the python path, so only the actual dependencies we wanted are available.
Signed-off-by: Matthew Peveler <mpeveler@timescale.com>
Bizarrely if you configure but don't use the pip cache, the setup-python action fails in its "post" step. See: actions/setup-python#436
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.