| Name | oxenai JSON |
| Version |
0.1.25
JSON |
| download |
| home_page | None |
| Summary | Data version control for machine learning |
| upload_time | 2023-09-20 01:38:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🐂 🐍 Oxen Python Interface
The Oxen python interface makes it easy to integrate Oxen datasets directly into machine learning dataloaders or other data pipelines.
## Repositories
There are two types of repositories one can interact with, a `LocalRepo` and a `RemoteRepo`.
## Local Repo
To fully clone all the data to your local machine, you can use the `LocalRepo` class.
```python
import oxen
repo = LocalRepo("path/to/repository")
repo.clone("https://hub.oxen.ai/ox/CatDogBBox")
```
If there is a specific version of your data you want to access, you can specify the `branch` when cloning.
```python
repo.clone("https://hub.oxen.ai/ox/CatDogBBox", branch="my-pets")
```
Once you have a repository locally, you can perform the same operations you might via the command line, through the python api.
For example, you can checkout a branch, add a file, commit, and push the data to the same remote you cloned it from.
```python
import oxen
repo = LocalRepo("path/to/repository")
repo.clone("https://hub.oxen.ai/ox/CatDogBBox")
repo.checkout()
```
## Remote Repo
If you don't want to download the data locally, you can use the `RemoteRepo` class to interact with a remote repository on OxenHub.
```python
import oxen
repo = RemoteRepo("https://hub.oxen.ai/ox/CatDogBBox")
```
To stage and commit files to a specific version of the data, you can `checkout` an existing branch or create a new one.
```python
repo.create_branch("dev")
repo.checkout("dev")
```
You can then stage files to the remote repository by specifying the file path and destination directory.
```python
repo.add("new-cat.png", "images") # Stage to images/new-cat.png on remote
repo.commit("Adding another training image")
```
Note that no "push" command is required here, since the above code creates a commit directly on the remote branch.
Raw data
{
"_id": null,
"home_page": null,
"name": "oxenai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1c/d6/5e222a9328e4bd445833b5ed88f64b7a3dc9975eda1a35be16200275eacc/oxenai-0.1.25.tar.gz",
"platform": null,
"description": "# \ud83d\udc02 \ud83d\udc0d Oxen Python Interface \n\nThe Oxen python interface makes it easy to integrate Oxen datasets directly into machine learning dataloaders or other data pipelines.\n\n## Repositories\n\nThere are two types of repositories one can interact with, a `LocalRepo` and a `RemoteRepo`.\n\n\n## Local Repo\n\nTo fully clone all the data to your local machine, you can use the `LocalRepo` class.\n\n```python\nimport oxen\n\nrepo = LocalRepo(\"path/to/repository\")\nrepo.clone(\"https://hub.oxen.ai/ox/CatDogBBox\")\n```\n\nIf there is a specific version of your data you want to access, you can specify the `branch` when cloning.\n\n```python\nrepo.clone(\"https://hub.oxen.ai/ox/CatDogBBox\", branch=\"my-pets\")\n```\n\nOnce you have a repository locally, you can perform the same operations you might via the command line, through the python api.\n\nFor example, you can checkout a branch, add a file, commit, and push the data to the same remote you cloned it from.\n\n```python\nimport oxen\n\nrepo = LocalRepo(\"path/to/repository\")\nrepo.clone(\"https://hub.oxen.ai/ox/CatDogBBox\")\nrepo.checkout()\n```\n\n## Remote Repo\n\nIf you don't want to download the data locally, you can use the `RemoteRepo` class to interact with a remote repository on OxenHub.\n\n```python\nimport oxen \n\nrepo = RemoteRepo(\"https://hub.oxen.ai/ox/CatDogBBox\")\n```\n\nTo stage and commit files to a specific version of the data, you can `checkout` an existing branch or create a new one.\n\n```python\nrepo.create_branch(\"dev\")\nrepo.checkout(\"dev\")\n```\n\nYou can then stage files to the remote repository by specifying the file path and destination directory.\n\n```python\nrepo.add(\"new-cat.png\", \"images\") # Stage to images/new-cat.png on remote\nrepo.commit(\"Adding another training image\")\n```\n\nNote that no \"push\" command is required here, since the above code creates a commit directly on the remote branch.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Data version control for machine learning",
"version": "0.1.25",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "73cb6a2c13be7224ba175c2d742dc8c46300a9e6306a33e8ea07b3893783bad3",
"md5": "5ef2d77d3f3c15cb56a612b9b8167f64",
"sha256": "e98cfabb5f289425d76de809c58a9b06c3d2b55a3cd78b9c9527a8f59e560d70"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp310-cp310-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "5ef2d77d3f3c15cb56a612b9b8167f64",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 16756803,
"upload_time": "2023-09-20T01:37:41",
"upload_time_iso_8601": "2023-09-20T01:37:41.645800Z",
"url": "https://files.pythonhosted.org/packages/73/cb/6a2c13be7224ba175c2d742dc8c46300a9e6306a33e8ea07b3893783bad3/oxenai-0.1.25-cp310-cp310-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dbcca18b3753eb3779b9c6e2d58d37611541f3391b07485138a38693297a9ca5",
"md5": "e75ca69925ee9fd99147441fd37c8a98",
"sha256": "4fdce590f3b0a0c413947ca592f43ad3338e269581d7f4752fefaf163fb37c7e"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp310-cp310-macosx_13_0_x86_64.whl",
"has_sig": false,
"md5_digest": "e75ca69925ee9fd99147441fd37c8a98",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 17630559,
"upload_time": "2023-09-20T01:37:44",
"upload_time_iso_8601": "2023-09-20T01:37:44.452945Z",
"url": "https://files.pythonhosted.org/packages/db/cc/a18b3753eb3779b9c6e2d58d37611541f3391b07485138a38693297a9ca5/oxenai-0.1.25-cp310-cp310-macosx_13_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "84df75245a36f0c8bf6cc567bfe079e970bd3b6e759ee74290a37cc695d6c122",
"md5": "8f6471f565e6c2082d0ace25222bcf4d",
"sha256": "1924cd72a18e365ab3e079bc9b1f96ec6ea4ebfce108e575b80a14e212dca356"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp310-cp310-manylinux_2_31_x86_64.whl",
"has_sig": false,
"md5_digest": "8f6471f565e6c2082d0ace25222bcf4d",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 24387084,
"upload_time": "2023-09-20T01:37:47",
"upload_time_iso_8601": "2023-09-20T01:37:47.091965Z",
"url": "https://files.pythonhosted.org/packages/84/df/75245a36f0c8bf6cc567bfe079e970bd3b6e759ee74290a37cc695d6c122/oxenai-0.1.25-cp310-cp310-manylinux_2_31_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b6a8175b285b7b26eeaa82c68cfeb821e13db3710401c462932a3ec19265ec46",
"md5": "171a35a821be08a28e83a7bb3d6ab818",
"sha256": "abb5b0c999260cc424a897e1cbb31d98c699c3bf92c2467459e18e862b5da8cb"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp310-cp310-manylinux_2_35_x86_64.whl",
"has_sig": false,
"md5_digest": "171a35a821be08a28e83a7bb3d6ab818",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 24975115,
"upload_time": "2023-09-20T01:37:50",
"upload_time_iso_8601": "2023-09-20T01:37:50.315735Z",
"url": "https://files.pythonhosted.org/packages/b6/a8/175b285b7b26eeaa82c68cfeb821e13db3710401c462932a3ec19265ec46/oxenai-0.1.25-cp310-cp310-manylinux_2_35_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b15e5fdedd904ff9ee6c56e4b6aa1623792ac67fbf96dbd30ff941ad0728a76d",
"md5": "8929ca6972d58889beb22e75c622f575",
"sha256": "53b7a291f44a1918002b214dcbb24ecb0df3c6212bbfb23f5670339927f8c188"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp310-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "8929ca6972d58889beb22e75c622f575",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 21416671,
"upload_time": "2023-09-20T01:37:52",
"upload_time_iso_8601": "2023-09-20T01:37:52.942598Z",
"url": "https://files.pythonhosted.org/packages/b1/5e/5fdedd904ff9ee6c56e4b6aa1623792ac67fbf96dbd30ff941ad0728a76d/oxenai-0.1.25-cp310-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c6b98be498ca0622c9de0feb16366f5ae11ca290433eb6d2ae70571ee4cba340",
"md5": "ffd0634bbb1e88d79b313d17a6490fbd",
"sha256": "48532c142adf6db4ec7861137faacb257e2b9bd3bfcd896ed9d0fb1c552f12d3"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp311-cp311-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "ffd0634bbb1e88d79b313d17a6490fbd",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 16756857,
"upload_time": "2023-09-20T01:37:55",
"upload_time_iso_8601": "2023-09-20T01:37:55.974485Z",
"url": "https://files.pythonhosted.org/packages/c6/b9/8be498ca0622c9de0feb16366f5ae11ca290433eb6d2ae70571ee4cba340/oxenai-0.1.25-cp311-cp311-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5d3cb136304b2814dea62ca6ed6db9a77ea8ef5d3663a70edb6a78a3a0222bde",
"md5": "e0bbb8236da23170539c9726ec1b7022",
"sha256": "7c43f96b548fa241e0307a41b1fc01b4620729fc98d535a495438d4e94ecdcc3"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp311-cp311-macosx_13_0_x86_64.whl",
"has_sig": false,
"md5_digest": "e0bbb8236da23170539c9726ec1b7022",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 17630656,
"upload_time": "2023-09-20T01:37:58",
"upload_time_iso_8601": "2023-09-20T01:37:58.928242Z",
"url": "https://files.pythonhosted.org/packages/5d/3c/b136304b2814dea62ca6ed6db9a77ea8ef5d3663a70edb6a78a3a0222bde/oxenai-0.1.25-cp311-cp311-macosx_13_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7a697fa52230c7a0f54e8070768a3f18d7ac4f97c3072c3d6b12da7de50aa6a7",
"md5": "6f67ddba77491f23b1d54a549435b559",
"sha256": "87aa96744dfe183e634a9d7e76a9940eb282b3de4778f4867d3128ea2b24708a"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp311-cp311-manylinux_2_31_x86_64.whl",
"has_sig": false,
"md5_digest": "6f67ddba77491f23b1d54a549435b559",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 24388276,
"upload_time": "2023-09-20T01:38:01",
"upload_time_iso_8601": "2023-09-20T01:38:01.519752Z",
"url": "https://files.pythonhosted.org/packages/7a/69/7fa52230c7a0f54e8070768a3f18d7ac4f97c3072c3d6b12da7de50aa6a7/oxenai-0.1.25-cp311-cp311-manylinux_2_31_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "afd416d6533187050bc781f529e084c0667390682796864998542aab228f1502",
"md5": "6a70311ed4a0a3bb5d33918f933d346c",
"sha256": "342fe48fc645fc2f7bb118d6f20dd77d1680eb65efb5ce6d29a41c8995f21f4c"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp311-cp311-manylinux_2_35_x86_64.whl",
"has_sig": false,
"md5_digest": "6a70311ed4a0a3bb5d33918f933d346c",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 24975622,
"upload_time": "2023-09-20T01:38:04",
"upload_time_iso_8601": "2023-09-20T01:38:04.675890Z",
"url": "https://files.pythonhosted.org/packages/af/d4/16d6533187050bc781f529e084c0667390682796864998542aab228f1502/oxenai-0.1.25-cp311-cp311-manylinux_2_35_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8098c4d9c337551802a5d41e4ef18c90879fca93309cd866b5d596e39560f508",
"md5": "b02a978f406f0b999e8538607befae9e",
"sha256": "d52b6d48da068d1a10fb64ba08180d2c3b1582d1cc67c48f42cae53c423114e5"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp311-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "b02a978f406f0b999e8538607befae9e",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 21416662,
"upload_time": "2023-09-20T01:38:07",
"upload_time_iso_8601": "2023-09-20T01:38:07.772273Z",
"url": "https://files.pythonhosted.org/packages/80/98/c4d9c337551802a5d41e4ef18c90879fca93309cd866b5d596e39560f508/oxenai-0.1.25-cp311-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c60cc94eb0ac5988cc73f99efe7531dcbfdcf80eae421236f9de996f2c3ad142",
"md5": "d19b2e687ad4ec86376ee9077d6b1942",
"sha256": "1d063cbc12af4a3ab0dd83f28f6cde1ed5407fc020807cb0cc3a08c66e4c4601"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp38-cp38-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "d19b2e687ad4ec86376ee9077d6b1942",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 16759147,
"upload_time": "2023-09-20T01:38:10",
"upload_time_iso_8601": "2023-09-20T01:38:10.700755Z",
"url": "https://files.pythonhosted.org/packages/c6/0c/c94eb0ac5988cc73f99efe7531dcbfdcf80eae421236f9de996f2c3ad142/oxenai-0.1.25-cp38-cp38-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0b5fc4fbdd6c8ae6f635ba627eb97b4d0578184533dccff8164a4556d25af4e2",
"md5": "9887ac84a04843ae7ec9ad1ee77f076a",
"sha256": "564f1fe34d51405768bffbb5a3137bb346b14925b63c5b9c76fde3f12bd024d2"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp38-cp38-macosx_13_0_x86_64.whl",
"has_sig": false,
"md5_digest": "9887ac84a04843ae7ec9ad1ee77f076a",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 17604031,
"upload_time": "2023-09-20T01:38:13",
"upload_time_iso_8601": "2023-09-20T01:38:13.810601Z",
"url": "https://files.pythonhosted.org/packages/0b/5f/c4fbdd6c8ae6f635ba627eb97b4d0578184533dccff8164a4556d25af4e2/oxenai-0.1.25-cp38-cp38-macosx_13_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "950476948fd9de80feedb2c613dcaeba968c84827cd3d38c04b5cfaa51d16ac1",
"md5": "b5d286609f75f6e645bcced7aa1366f1",
"sha256": "5d8258818405fa659971762d82ade3d364dd1766ce987da2bd1a1f1cf4900094"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp38-cp38-manylinux_2_31_x86_64.whl",
"has_sig": false,
"md5_digest": "b5d286609f75f6e645bcced7aa1366f1",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 24396772,
"upload_time": "2023-09-20T01:38:17",
"upload_time_iso_8601": "2023-09-20T01:38:17.183466Z",
"url": "https://files.pythonhosted.org/packages/95/04/76948fd9de80feedb2c613dcaeba968c84827cd3d38c04b5cfaa51d16ac1/oxenai-0.1.25-cp38-cp38-manylinux_2_31_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "abcabdf933df56f7057e97219137b9b2b7741fe17598d30d6bcee58f36a9f208",
"md5": "949a682ce2947eb386b255a981eb9f79",
"sha256": "dd77205951121b644c5bd59914b5dcf302bdf5a2dd9904ab47efc58085f9c4d1"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp38-cp38-manylinux_2_35_x86_64.whl",
"has_sig": false,
"md5_digest": "949a682ce2947eb386b255a981eb9f79",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 24982907,
"upload_time": "2023-09-20T01:38:19",
"upload_time_iso_8601": "2023-09-20T01:38:19.748398Z",
"url": "https://files.pythonhosted.org/packages/ab/ca/bdf933df56f7057e97219137b9b2b7741fe17598d30d6bcee58f36a9f208/oxenai-0.1.25-cp38-cp38-manylinux_2_35_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4fa85f5b22d9290a3d8650a63d579e046c7434a63dc2f559535a45b1d3e9ad21",
"md5": "32b973f5dec658a2cc7d7896cd53572d",
"sha256": "77b10272e2c103bd4ee8b3bf3842e46d4e8a005bbd7c6d365a16a0149cb72302"
},
"downloads": -1,
"filename": "oxenai-0.1.25-cp38-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "32b973f5dec658a2cc7d7896cd53572d",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 21451218,
"upload_time": "2023-09-20T01:38:22",
"upload_time_iso_8601": "2023-09-20T01:38:22.531059Z",
"url": "https://files.pythonhosted.org/packages/4f/a8/5f5b22d9290a3d8650a63d579e046c7434a63dc2f559535a45b1d3e9ad21/oxenai-0.1.25-cp38-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1cd65e222a9328e4bd445833b5ed88f64b7a3dc9975eda1a35be16200275eacc",
"md5": "edf7cfa29582f1854dc8208f5dd2e8df",
"sha256": "b15669ea5fc8204fd89a6b41dc06193eec6450e4e2cb5cf3381f965706715f38"
},
"downloads": -1,
"filename": "oxenai-0.1.25.tar.gz",
"has_sig": false,
"md5_digest": "edf7cfa29582f1854dc8208f5dd2e8df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 135339,
"upload_time": "2023-09-20T01:38:25",
"upload_time_iso_8601": "2023-09-20T01:38:25.294402Z",
"url": "https://files.pythonhosted.org/packages/1c/d6/5e222a9328e4bd445833b5ed88f64b7a3dc9975eda1a35be16200275eacc/oxenai-0.1.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-20 01:38:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "oxenai"
}
