Getting Started
What is Datature's CLI?
Datature constantly strives to make MLOps accessible for all users, from individual developers to large enterprises with established codebases. With that in mind, one of the tools we are making accessible is our Command Line Interface (CLI), which allows you to easily perform general interactions at all the essential steps of the MLOps pipeline just through simple shell commands.
The main function categories are as follows:
Function Category | Description |
---|---|
Project Management | This gives you the essential functions to authing and lists basic information about your projects. |
Asset Management | This deals with the upload and lists basic information of assets on the Nexus platform. |
Annotation Management | This deals with the upload and download of annotations stored on the Nexus platform. |
Artifact Management | This allows users to download the artifact models stored on the Nexus platform. |
How to Get Started
Install Python 3.8 or Above
As this is an SDK for Python, users will need to ensure that they have Python installed. As of now, we currently fully support all versions of Python from 3.8 or above. If you are having issues with the SDK, please ensure that your environment uses an Python version that is fully supported, or else we are not able to guarantee functionality or fixes.
Install Datature's CLI
To make installation as simple as possible, we have made the Python package available on PIP, Python's most popular package installation tool. After ensuring you have pip installed in your environment, which should come with a standard Python installation, you can simply enter the following command below.
pip install --upgrade datature
The CLI will be included in the installation of the pip package.
Authentication
The final step that is essential to all successful requests is to ensure that you log on to the platform, access the relevant project, and store the project secret key which can be found in Integrations. As mentioned in the following link, only the project owner or those with relevant permissions can have access to the project secret on the platform. For more details on the project key and secret key, check out this link for more information.
Once you have the project secret, you will now be able to make API requests using the CLI by entering the command datature projects auth
:
datature projects auth
[?] Enter the project secret: ************************************************
[?] Make [Your Project Name] the default project? (Y/n): y
Authentication succeeded.
You will now be able to run your desired CLI commands as outlined above. To see all possible functions as well as view the required inputs and expected outputs, check out the above documentation.
Updated 10 months ago