Started image upload implementation

README.md

@@ -16,11 +16,16 @@ aixplain is a software development kit (SDK) for the [aiXplain](https://aixplain
 ## Getting Started
 
 ### Installation
-To install simply,
+To install the base package, simply,
 ```bash
 pip install aixplain
 ```
 
+To  install aiXplain with additional model building support:
+```bash
+pip install aixplain[model-builder]
+```
+
 ###  API Key Setup
 Before you can use the aixplain SDK, you'll need to obtain an API key from our platform. For details refer this [Team API Key Guide](docs/user/api_setup.md).
 
@@ -63,4 +68,4 @@ Raise issues for support in this repository.
 Pull requests are welcome!
 
 ## Note
-The **aiXtend** python package was renamed to **aiXplain** from the release v0.1.1.
+The **aiXtend** python package was renamed to **aiXplain** from the release v0.1.1.

aixplain/cli_groups.py

@@ -0,0 +1,58 @@
+__author__ = "aiXplain"
+
+"""
+Copyright 2022 The aiXplain SDK authors
+
+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.
+
+Author: Michael Lam
+Date: September 18th 2023
+Description:
+    CLI Runner
+"""
+import click
+from aixplain.factories.cli.model_factory_cli import list_host_machines, list_functions, create_asset_repo, asset_repo_login, onboard_model
+
+@click.group('cli')
+def cli():
+    pass
+
+@click.group('list')
+def list():
+    pass
+
+@click.group('get')
+def get():
+    pass
+
+@click.group('create')
+def create():
+    pass
+
+@click.group('onboard')
+def onboard():
+    pass
+
+cli.add_command(list)
+cli.add_command(get)
+cli.add_command(create)
+cli.add_command(onboard)
+
+create.add_command(create_asset_repo)
+list.add_command(list_host_machines)
+list.add_command(list_functions)
+get.add_command(asset_repo_login)
+onboard.add_command(onboard_model)
+
+def run_cli():
+    cli()

aixplain/factories/cli/model_factory_cli.py

@@ -0,0 +1,137 @@
+__author__ = "aiXplain"
+
+"""
+Copyright 2022 The aiXplain SDK authors
+
+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.
+
+Author: Michael Lam
+Date: September 18th 2023
+Description:
+    Model Factory CLI
+"""
+
+from aixplain.factories.model_factory import ModelFactory
+from typing import Dict, List, Optional, Text
+import click
+import yaml
+
+@click.command("hosts")
+@click.option("--api-key", default=None, 
+              help="TEAM_API_KEY if not already set in environment")
+def list_host_machines(api_key: Optional[Text] = None) -> None:
+    """CLI wrapper function for the LIST_HOST_MACHINES function in 
+    ModelFactory.
+
+    Args:
+        api_key (Text, optional): Team API key. Defaults to None.
+
+    Returns:
+        None
+    """
+    ret_val = ModelFactory.list_host_machines(api_key)
+    ret_val_yaml = yaml.dump(ret_val)
+    click.echo(ret_val_yaml)
+
+@click.command("functions")
+@click.option("--verbose", default=False, 
+              help="List all function details, False by default.")
+@click.option("--api-key", default=None, 
+              help="TEAM_API_KEY if not already set in environment.")
+def list_functions(verbose: bool, api_key: Optional[Text] = None) -> None:
+    """CLI wrapper function for the LIST_FUNCTIONS function in ModelFactory.
+
+    Args:
+        verbose (Boolean, optional): Set to True if a detailed response 
+            is desired; is otherwise False by default.
+        api_key (Text, optional): Team API key. Defaults to None.
+    Returns:
+        None
+    """
+    ret_val = ModelFactory.list_functions(verbose, api_key)
+    ret_val_yaml = yaml.dump(ret_val)
+    click.echo(ret_val_yaml)
+
+@click.command("image-repo")
+@click.option("--name", help="Model name.")
+@click.option("--hosting-machine", 
+              help="Hosting machine code obtained from LIST_HOSTS.")
+@click.option("--version", help="Model version.")
+@click.option("--description", help="Description of model.")
+@click.option("--function", help="Function name obtained from LIST_FUNCTIONS.")
+@click.option("--source-language", default="en", 
+              help="Model source language in 2-character 639-1 code or 3-character 639-3 code.")
+@click.option("--api-key", default=None, 
+              help="TEAM_API_KEY if not already set in environment.")
+def create_asset_repo(name: Text, hosting_machine: Text, version: Text, 
+                          description: Text, function: Text, 
+                          source_language: Text, 
+                          api_key: Optional[Text] = None) -> None:
+    """CLI wrapper function for the CREATE_ASSET_REPO function in ModelFactory.
+
+    Args:
+        name (Text): Model name
+        hosting_machine (Text): Hosting machine ID obtained via list_host_machines
+        always_on (bool): Whether the model should always be on
+        version (Text): Model version
+        description (Text): Model description
+        function (Text): Model function name obtained via LIST_HOST_MACHINES
+        is_async (bool): Whether the model is asynchronous or not (False in first release)
+        source_language (Text): 2-character 639-1 code or 3-character 639-3 language code.
+        api_key (Text, optional): Team API key. Defaults to None.
+
+    Returns:
+        None
+    """
+    ret_val = ModelFactory.create_asset_repo(name, hosting_machine, version, 
+                                             description, function, 
+                                             source_language, api_key)
+    ret_val_yaml = yaml.dump(ret_val)
+    click.echo(ret_val_yaml)
+
+@click.command("image-repo-login")
+@click.option("--api-key", default=None, 
+              help="TEAM_API_KEY if not already set in environment.")
+def asset_repo_login(api_key: Optional[Text] = None) -> None:
+    """CLI wrapper function for the ASSET_REPO_LOGIN function in ModelFactory.
+
+    Args:
+        api_key (Text, optional): Team API key. Defaults to None.
+
+    Returns:
+        None
+    """
+    ret_val = ModelFactory.asset_repo_login(api_key)
+    ret_val_yaml = yaml.dump(ret_val)
+    click.echo(ret_val_yaml)
+
+@click.command("model")
+@click.option("--model-id", help="Model ID from CREATE_IMAGE_REPO.")
+@click.option("--image-tag", help="The tag of the image that you would like hosted.")
+@click.option("--image-hash", help="The hash of the image you would like onboarded.")
+@click.option("--api-key", default=None, help="TEAM_API_KEY if not already set in environment.")
+def onboard_model(model_id: Text, image_tag: Text, image_hash: Text, 
+                  api_key: Optional[Text] = None) -> None:
+    """CLI wrapper function for the ONBOARD_MODEL function in ModelFactory.
+
+    Args:
+        model_id (Text): Model ID obtained from CREATE_ASSET_REPO.
+        image_tag (Text): Image tag to be onboarded.
+        api_key (Text, optional): Team API key. Defaults to None.
+
+    Returns:
+        None
+    """   
+    ret_val = ModelFactory.onboard_model(model_id, image_tag, image_hash, api_key)
+    ret_val_yaml = yaml.dump(ret_val)
+    click.echo(ret_val_yaml)