Skip to main content

Create altergo model

🧰 create-altergo-model​

The Create-Altergo-Model feature allows you to quickly generate an Altergo model template with customizable parameters, streamlining your development process.

📄 Overview​

The create-altergo-model script prompts you for essential information and generates a model directory with pre-configured templates.

🚀 Usage​

After installing the Altergo SDK, you can use the create-altergo-model command-line tool:

create-altergo-model

Example Interaction:

Enter the name of the model: MyModel
Enter your Altergo API Key: abc123
Enter your Altergo instance name: mycompany
Enter the Asset ID (leave empty if not applicable):
Created folder 'MyModel'
Altergo model 'MyModel' has been created successfully.

📁 Generated Files​

The tool generates a new directory with the following files:

  • dev-parameters.json: Configuration file with your provided parameters.
  • entrypoint.py: Entry point script for your model.
  • model-configuration.json: Model configuration settings.
  • model-validation.json: Model validation schema.
  • requirements.txt: Python dependencies for your model.
  • README.md: Documentation for your model.
  • .gitignore: Pre-configured gitignore file.

📝 Customization​

The dev-parameters.json file is populated with the information you provide:

{
    "altergoUserApiKey": "abc123",
    "altergoFactoryApi": "http://mycompany.altergo.io",
    "altergoIotApi": "http://mycompany.altergo.io",
    "assetId": ""
}

Note: You can update assetId in dev-parameters.json after creation if applicable.

⚠️ Important Notes​

  • Do not commit sensitive information like API keys to version control.
  • Ensure that you have the necessary permissions to create files in the target directory.