Update dependency verification doc, pull out snippets #196
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| {/* Auto-generated by scripts/mdx_snippets_gen.py. Do not edit manually. */} | ||
|
|
||
| export const PyCondaManifestInline = "from geneva.manifest.builder import CondaManifestBuilder\n\nmanifest = (\n CondaManifestBuilder.create(\"my-manifest\")\n .conda({\n \"channels\": [\"conda-forge\"],\n \"dependencies\": [\n \"python=3.10\",\n \"ffmpeg<8\",\n \"torchvision=0.22.1\",\n ],\n })\n .build()\n)\n"; | ||
|
Contributor
There was a problem hiding this comment. nit:
Contributor
Author
|
||
|
|
||
| export const PyCondaManifestPath = "from geneva.manifest.builder import CondaManifestBuilder\n\nmanifest = (\n CondaManifestBuilder.create(\"my-manifest\")\n .conda_environment_path(\"environment.yml\")\n .build()\n)\n"; | ||
|
|
||
| export const PyCondaClusterInline = "from geneva.cluster.builder import KubeRayClusterBuilder\n\ncluster = (\n KubeRayClusterBuilder.create(\"my-cluster\")\n .ray_init_kwargs({\n \"runtime_env\": {\n \"conda\": {\n \"channels\": [\"conda-forge\"],\n \"dependencies\": [\n \"python=3.10\",\n \"ffmpeg<8\",\n \"torchvision=0.22.1\",\n ],\n },\n \"config\": {\"eager_install\": True},\n }\n })\n .build()\n)\n"; | ||
|
|
||
| export const PyCondaClusterPath = "from geneva.cluster.builder import KubeRayClusterBuilder\n\ncluster = (\n KubeRayClusterBuilder.create(\"my-cluster\")\n .ray_init_kwargs({\n \"runtime_env\": {\"conda\": \"environment.yml\"}\n })\n .build()\n)\n"; | ||
|
|
||
| export const PyEnvVarsViaCluster = "from geneva.cluster.builder import KubeRayClusterBuilder\nimport os\n\ncluster = (\n KubeRayClusterBuilder.create(\"my-cluster\")\n .ray_init_kwargs({\n \"runtime_env\": {\n \"env_vars\": {\n \"AWS_ACCESS_KEY_ID\": os.environ[\"AWS_ACCESS_KEY_ID\"],\n \"AWS_SECRET_ACCESS_KEY\": os.environ[\"AWS_SECRET_ACCESS_KEY\"],\n }\n }\n })\n .build()\n)\n"; | ||
|
|
||
| export const PyPipManifest = "import geneva\nfrom geneva.manifest.builder import PipManifestBuilder\n\nmanifest = (\n PipManifestBuilder.create(\"my-manifest\")\n .pip([\n \"numpy==1.26.4\",\n \"torch==2.0.1\",\n \"attrs==23.2.0\",\n ])\n .build()\n)\n\nconn = geneva.connect(\"s3://my-bucket/my-db\")\nconn.define_manifest(\"my-manifest\", manifest)\nwith conn.context(cluster=\"my-cluster\", manifest=\"my-manifest\"):\n conn.open_table(\"my-table\").backfill(\"my-column\")\n"; | ||
|
|
||
| export const PyQuickFixManifest = "from geneva.manifest.builder import PipManifestBuilder\n\nmanifest = PipManifestBuilder.create(\"fix\").pip([\"numpy==1.26.4\"]).build()\n"; | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # SPDX-FileCopyrightText: Copyright The LanceDB Authors | ||
|
|
||
| import os | ||
|
|
||
| import pytest | ||
|
|
||
|
|
||
| def test_quick_fix_manifest(): | ||
| # --8<-- [start:quick_fix_manifest] | ||
| from geneva.manifest.builder import PipManifestBuilder | ||
|
|
||
| manifest = PipManifestBuilder.create("fix").pip(["numpy==1.26.4"]).build() | ||
| # --8<-- [end:quick_fix_manifest] | ||
| assert manifest.pip == ["numpy==1.26.4"] | ||
|
|
||
|
|
||
| def test_env_vars_via_cluster(monkeypatch): | ||
| monkeypatch.setenv("AWS_ACCESS_KEY_ID", "test-key-id") | ||
| monkeypatch.setenv("AWS_SECRET_ACCESS_KEY", "test-secret") | ||
|
|
||
| # --8<-- [start:env_vars_via_cluster] | ||
| from geneva.cluster.builder import KubeRayClusterBuilder | ||
| import os | ||
|
|
||
| cluster = ( | ||
| KubeRayClusterBuilder.create("my-cluster") | ||
| .ray_init_kwargs({ | ||
| "runtime_env": { | ||
| "env_vars": { | ||
| "AWS_ACCESS_KEY_ID": os.environ["AWS_ACCESS_KEY_ID"], | ||
| "AWS_SECRET_ACCESS_KEY": os.environ["AWS_SECRET_ACCESS_KEY"], | ||
| } | ||
| } | ||
| }) | ||
| .build() | ||
| ) | ||
| # --8<-- [end:env_vars_via_cluster] | ||
| assert cluster.kuberay.ray_init_kwargs["runtime_env"]["env_vars"]["AWS_ACCESS_KEY_ID"] == "test-key-id" | ||
|
|
||
|
|
||
| def test_pip_manifest(monkeypatch): | ||
| from unittest.mock import MagicMock | ||
| mock_conn = MagicMock() | ||
| monkeypatch.setattr("geneva.connect", MagicMock(return_value=mock_conn)) | ||
|
|
||
| # --8<-- [start:pip_manifest] | ||
| import geneva | ||
| from geneva.manifest.builder import PipManifestBuilder | ||
|
|
||
| manifest = ( | ||
| PipManifestBuilder.create("my-manifest") | ||
| .pip([ | ||
| "numpy==1.26.4", | ||
| "torch==2.0.1", | ||
| "attrs==23.2.0", | ||
| ]) | ||
| .build() | ||
| ) | ||
|
|
||
| conn = geneva.connect("s3://my-bucket/my-db") | ||
| conn.define_manifest("my-manifest", manifest) | ||
| with conn.context(cluster="my-cluster", manifest="my-manifest"): | ||
| conn.open_table("my-table").backfill("my-column") | ||
| # --8<-- [end:pip_manifest] | ||
| assert "numpy==1.26.4" in manifest.pip | ||
|
|
||
|
|
||
| def test_conda_cluster_path(): | ||
| # --8<-- [start:conda_cluster_path] | ||
| from geneva.cluster.builder import KubeRayClusterBuilder | ||
|
|
||
| cluster = ( | ||
| KubeRayClusterBuilder.create("my-cluster") | ||
| .ray_init_kwargs({ | ||
| "runtime_env": {"conda": "environment.yml"} | ||
| }) | ||
| .build() | ||
| ) | ||
| # --8<-- [end:conda_cluster_path] | ||
| assert cluster.kuberay.ray_init_kwargs["runtime_env"]["conda"] == "environment.yml" | ||
|
|
||
|
|
||
| def test_conda_cluster_inline(): | ||
| # --8<-- [start:conda_cluster_inline] | ||
| from geneva.cluster.builder import KubeRayClusterBuilder | ||
|
|
||
| cluster = ( | ||
| KubeRayClusterBuilder.create("my-cluster") | ||
| .ray_init_kwargs({ | ||
| "runtime_env": { | ||
| "conda": { | ||
| "channels": ["conda-forge"], | ||
| "dependencies": [ | ||
| "python=3.10", | ||
| "ffmpeg<8", | ||
| "torchvision=0.22.1", | ||
| ], | ||
| }, | ||
| "config": {"eager_install": True}, | ||
| } | ||
| }) | ||
| .build() | ||
| ) | ||
| # --8<-- [end:conda_cluster_inline] | ||
| assert cluster.kuberay.ray_init_kwargs["runtime_env"]["conda"]["channels"] == ["conda-forge"] |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This little bit is still untested because the env_vars method was just added today; once it's in the next release we can pull it out into a snippet as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
both of these apis are valid but pip is preferred.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nope, GenevaManifestBuilder doesn't exist anymore, that's what got me started on this whole thing anyway 😆