cometx 2.2.17__tar.gz

cometx-2.2.17/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cometx-2.2.17/PKG-INFO

@@ -0,0 +1,416 @@
+Metadata-Version: 2.1
+Name: cometx
+Version: 2.2.17
+Summary: Python tools for Comet
+Home-page: https://github.com/comet-ml/comet-sdk-extensions/
+Author: cometx development team
+License: MIT License
+Keywords: ai,artificial intelligence,python,machine learning
+Platform: Linux
+Platform: Mac OS X
+Platform: Windows
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Framework :: Jupyter
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: comet_ml
+
+# cometx
+
+```
+   _________  ____ ___  ___  / /__  __
+  / ___/ __ \/ __ `__ \/ _ \/ __/ |/_/
+ / /__/ /_/ / / / / / /  __/ /__>  <
+ \___/\____/_/ /_/ /_/\___/\__/_/|_|
+```
+
+Open source extensions for the [Comet](https://www.comet.com/site/?utm_source=cometx&utm_medium=referral&utm_campaign=cometx_2022&utm_content=github) SDK.
+
+These extensions are created and supported by the community and are
+not an official project of Comet ML. We welcome contributions!
+
+## Installation
+
+```
+pip install cometx
+```
+
+To use these command-line functions, you'll need to have your Comet
+API key set in one of the following two ways.
+
+1. [Environment variables](https://www.comet.com/docs/v2/guides/tracking-ml-training/configuring-comet/?utm_source=cometx&utm_medium=referral&utm_campaign=cometx_2022&utm_content=github#configure-comet-through-environment-variables)
+2. [Comet config file](https://www.comet.com/docs/v2/guides/tracking-ml-training/configuring-comet/?utm_source=cometx&utm_medium=referral&utm_campaign=cometx_2022&utm_content=github#configure-comet-using-the-comet-config-file)
+
+Either this way:
+
+```
+export COMET_API_KEY="YOUR-COMET-API-KEY"
+```
+
+or this way:
+
+```
+[comet]
+api_key = YOUR-COMET-API-KEY
+```
+
+If you are an Comet on-prem user, you'll also need to set the
+`COMET_URL_OVERRIDE` environment variable, or add it to your
+`~/.comet.config` file as below:
+
+Either this way:
+
+```
+export COMET_API_KEY="YOUR-COMET-API-KEY"
+export COMET_URL_OVERRIDE="https://your-companys-comet.com/clientlib/"
+```
+
+or this way:
+
+```
+[comet]
+api_key = YOUR-COMET-API-KEY
+url_override = https://your-companys-comet.com/clientlib/
+```
+
+## Usage
+
+`cometx` is composed of a series of subcommands that are useful
+independently, and can be used together to create sophisticated tools
+for ML management.
+
+This section will examine some common uses, followed by a more
+detailed exploration of each subcommand.
+
+### Use Cases
+
+In this section we'll explore some common scenarios.
+
+1. Copy a specific project from one Comet installation to another
+2. Copy all projects in workspace to a new workspace
+4. Copy specific experiments in a project to new experiments
+
+## 1. Copy a specific project from one comet installation to another
+
+A useful idiom is to set your Comet environment variables on the line
+of a subcommand. In this manner, you can set the `COMET_URL_OVERRIDE`
+and `COMET_API_KEY` for different installations.
+
+Of course, you don't have to set the environment variables if you are
+copying experiments on the same Comet installation.
+
+Here is how you one could download the experiments in
+WORKSPACE/PROJECT from http://comet.a.com:
+
+```shell
+COMET_URL_OVERRIDE=http://comet.a.com/clientlib \
+COMET_API_KEY=A-KEY \
+cometx download WORKSPACE/PROJECT
+```
+
+The `cometx download` subcommand downloads all of the Comet experiment
+data into local files. Note that WORKSPACE/PROJECT refers to a
+workspace and project on http://comet.a.com.
+
+One could then copy the downloaded experiment data with a similar command:
+
+```shell
+COMET_URL_OVERRIDE=http://comet.b.com/clientlib \
+COMET_API_KEY=B-KEY \
+cometx copy WORKSPACE/PROJECT NEW-WORKSPACE/NEW-PROJECT
+```
+
+Note that WORKSPACE/PROJECT now refers to a directory, and
+NEW-WORKSPACE/NEW-PROJECT refers to a workspace and project on
+http://comet.b.com.
+
+## 2. Copy all projects in workspace to a new workspace
+
+Similarly, one can copy all of the projects by first downloading them:
+
+```shell
+COMET_URL_OVERRIDE=http://comet.a.com/clientlib \
+COMET_API_KEY=A-KEY \
+cometx download WORKSPACE
+```
+
+and then copying them:
+
+```shell
+COMET_URL_OVERRIDE=http://comet.b.com/clientlib \
+COMET_API_KEY=B-KEY \
+cometx copy WORKSPACE NEW-WORKSPACE
+```
+
+## 3. Copy specific experiments in a project to new experiments
+
+Similarly, one can copy a single experiment first downloading it:
+
+```shell
+COMET_URL_OVERRIDE=http://comet.a.com/clientlib \
+COMET_API_KEY=A-KEY \
+cometx download WORKSPACE/PROJECT/EXPERIMENT-NAME-OR-ID
+```
+
+and then copying it:
+
+```shell
+COMET_URL_OVERRIDE=http://comet.b.com/clientlib \
+COMET_API_KEY=B-KEY \
+cometx copy WORKSPACE/PROJECT/EXPERIMENT-NAME-OR-ID NEW-WORKSPACE/NEW-PROJECT
+```
+
+### Subcommands
+
+* [cometx list](#cometx-list)
+* [cometx download](#cometx-download)
+* [cometx copy](#cometx-copy)
+* [cometx log](#cometx-log)
+* [cometx reproduce](#cometx-reproduce)
+* [cometx delete-assets](#cometx-delete-assets)
+
+
+For all subcommands, use the `--help` flag to get additional information.
+
+## cometx list
+
+This command is used to:
+
+* get a list of all workspaces that you are a member of
+* get a list of all projects in a workspace
+* get a list of all experiments (by name or key) in a project
+
+cometx list examples:
+
+```
+cometx list WORKSPACE/PROJECT/EXPERIMENT-KEY-OR-NAME
+cometx list WORKSPACE/PROJECT
+cometx list WORKSPACE
+cometx list
+```
+
+### Flags
+
+* `--query` - use to limit the experiments to download (see [experiment.api.query()](https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/API/#apiquery) for more information)
+*  `-u`, `--use-name` - use experiment names for experiment folders and listings
+
+For more information, `cometx list --help`
+
+## cometx copy
+
+This command is used to:
+
+* copy downloaded data to a new experiment
+* create a symlink from one project to existing experiments
+
+cometx copy examples:
+
+```
+cometx SOURCE DESTINATION
+cometx --symlink SOURCE DESTINATION
+```
+
+where SOURCE is:
+
+* if not `--symlink`, "WORKSPACE/PROJECT/EXPERIMENT", "WORKSPACE/PROJECT/*", or "WORKSPACE/*/*" folder (use quotes)
+* if `--symlink`, then it is a Comet path to workspace or workspace/project
+
+where DESTINATION is:
+
+* WORKSPACE
+* WORKSPACE/PROJECT
+
+Not all combinations are possible:
+
+
+| Destination → <br/>Source ↓ | WORKSPACE            | WORKSPACE/PROJECT      |
+|--------------------|----------------------|------------------------|
+| `WORKSPACE/*/*`      | Copies all projects  | N/A                    |
+| `WORKSPACE/PROJ/*`   | N/A                  | Copies all experiments |
+| `WORKSPACE/PROJ/EXP` | N/A                  | Copies experiment      |
+
+
+For more information, `cometx copy --help`
+
+## cometx download
+
+This command is used to:
+
+* download all workspaces, projects, and experiments of workspaces that you are a member of
+* download all projects, and experiments of a given workspace
+* download all experiments of a given workspace/project
+
+cometx dowload examples:
+
+```
+cometx download WORKSPACE/PROJECT/EXPERIMENT-KEY-OR-NAME [RESOURCE ...] [FLAGS ...]
+cometx download WORKSPACE/PROJECT [RESOURCE ...] [FLAGS ...]
+cometx download WORKSPACE [RESOURCE ...] [FLAGS ...]
+cometx download [RESOURCE ...] [FLAGS ...]
+```
+
+Where [RESOURCE ...] is zero or more of the following names:
+
+* assets
+* html
+* metadata
+* metrics
+* others
+* parameters
+* project - alias for: project_notes, project_metadata
+* run - alias for: code, git, output, graph, and requirements
+* system
+
+If no RESOURCE is given it will download all of them.
+
+## Flags
+
+* `--query` - use to limit the experiments to download (see [experiment.api.query()](https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/API/#apiquery) for more information)
+* `--list` - use to list available workspaces, projects, experiments,
+    artifacts, or models (same as `cometx list`)
+* `--output` - download resources to folder other than current one
+* `--flat` - don't use the normal hiearchy for downloaded items
+* `--use-name` - use experiment names for folders and listings
+* `--ignore` - don't download the following resources (use one or more
+    RESOURCE names from above)
+* `--asset-type` - asset type to match, or leave off to match all
+* `--filename` - filename to match, or leave off to match all
+* `--overwrite` - overwrite any existing files
+* `--force` - don't ask to download, just do it
+* `--help` - this message
+
+To download artifacts:
+
+```
+cometx download WORKSPACE/artifacts/NAME [FLAGS ...]
+cometx download WORKSPACE/artifacts/NAME/VERSION-OR-ALIAS [FLAGS ...]
+```
+
+To download models from the model registry:
+
+```
+cometx download WORKSPACE/model-registry/NAME [FLAGS ...]
+cometx download WORKSPACE/model-registry/NAME/VERSION-OR-STAGE [FLAGS ...]
+```
+
+For more information, `cometx download --help`
+
+
+## cometx log
+
+This command is used to log a resource (metrics, parameters, asset,
+etc) file to a specific experiment or experiments.
+
+cometx log example:
+
+```
+cometx log WORKSPACE/PROJECT/EXPERIMENT-KEY-OR-NAME [--type TYPE] FILENAME.EXT
+```
+
+where TYPE is the asset type of the filename. TYPE is not needed if the
+filename extension (FILENAME.EXT) is known.
+
+Known extensions:
+
+* png
+* jpg
+* gif
+* txt
+* webm
+* mp4
+* ogg
+* ipynb
+* wav
+* mp3
+
+Known types:
+
+* asset
+* image
+* text-sample
+* video
+* ipynb
+* audio
+
+Example to set an other key:value:
+
+```
+cometx log WORKSPACE/PROJECT --type other --set "key:value"
+cometx log WORKSPACE/PROJECT/EXPERIMENT-KEY-OR-NAME --type other --set "key:value"
+```
+The first version will set the other key:value in all experiments in a project, and the second will set the other key:value in the experiment.
+
+
+Example to log all items:
+
+```
+cometx log WORKSPACE/PROJECT PATH-TO-DOWNLOAD --type all
+cometx log WORKSPACE/PROJECT/EXPERIMENT-KEY-OR-NAME PATH-TO-DOWNLOAD --type all
+```
+The first version will create an experiment, and the second will log everything to an existing experiment.
+
+### Flags
+
+* `--query` - use to limit the experiments to download (see [experiment.api.query()](https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/API/#apiquery) for more information)
+* `--type` - the type of item to log
+* `--set` - the "key:value" to log
+
+For more information, `cometx log --help`
+
+## cometx delete-assets
+
+To delete experiments assets:
+
+```
+cometx delete-assets WORKSPACE/PROJECT --type=image
+cometx delete-assets WORKSPACE/PROJECT/EXPERIMENT --type=all
+```
+Type can be valid asset tupe, including:
+
+* all
+* asset
+* audio
+* code
+* image
+* notebook
+* text-sample
+* video
+
+For more information, `cometx delete-assets --help`
+
+## cometx reproduce
+
+```
+cometx reproduce [-h] [--run] [--executable EXECUTABLE] COMET_PATH OUTPUT_DIR
+```
+
+For more information, `cometx reproduce --help`
+
+## Running Tests
+
+WARNING: Running the tests will create experiments, models, assets, etc.
+in your default workspace if not set otherwise.
+
+To run the tests, you can either export all of these items in the
+environment:
+
+```shell
+$ export COMET_USER="<USERNAME>"
+$ export COMET_WORKSPACE="<WORKSPACE>"
+$ export COMET_API_KEY="<API-KEY>"
+$ pytest tests
+```
+
+Or, define `workspace` and `api_key` in your ~/.comet.config file:
+
+```shell
+$ export COMET_USER="<USERNAME>"
+$ pytest tests
+```