How to Publish on AXES
AXES allows developers to publish and monetize their AI applications while providing users with a unified, privacy-focused platform to access these services.
As a developer, you have the opportunity to showcase your AI apps to a large user base, gain visibility, and monetize your creations. Whether you are a seasoned developer or new to the AXES ecosystem, this guide will walk you through the steps to successfully create, deploy, and manage your AI apps.
Overview
The AXES platform consists of the following main components relevant to developers:
App Node Clients: They are the fundamental building blocks of AI apps on AXES. Each AI application is encapsulated within a node client, which acts as a subnet or app node within the AXES network.
Axes Developer Hub: The Axes Hub is the central platform where developers can create, manage, and publish their applets. It provides an intuitive interface and tools for app development and deployment.
Smart Contracts: AXES utilizes smart contracts to govern the behavior and interactions within the network. Developers can deploy their own smart contracts to define the functionality and rules of their AI apps.
Prerequisites
Before you begin, ensure that you have the following:
AXES Developer Account: You will need an AXES smart account to register as a developer to publish apps. Follow this guide to get your developer account: Creating a Publisher Account
Application Files: Prepare your AI application files, including code, dependencies, and any necessary configurations.
Infrastructure Requirements: Determine the infrastructure requirements for your AI application, such as CPU, GPU, or TPU specifications.
Creating an AI Application
To create an AI application on the AXES platform, follow these steps:
Connect Repository: If your application code is hosted on a git repository (e.g., GitHub, GitLab, Bitbucket), connect your git account to AXES using the
axes.connect(git)
method in the Dev Dashboard. If you are not using a git repository, you can manually upload your application files and folders.Create Application Details: Provide comprehensive information about your AI application, including:
Application metadata
Long and short descriptions
Co-owners (if applicable)
Category of AI application
Custom input and output examples
Relevant tags for improved searchability
Terms of use and privacy policy
Build Application Image: Create a Docker image for your AI application. You can either use a custom CI/CD workflow or utilize the auto-containerization feature provided by AXES. If you opt for auto-containerization, fill out the necessary form inputs to assist in building the image.
Deploy Application: Once your application image is built, deploy it to the AXES Smart Hubs. The image will undergo automated testing to ensure its stability and compatibility. During the deployment process, you will be prompted to specify the hardware requirements that best suit your application's needs. AXES provides elastic load balancing and auto-scaling capabilities to handle varying workloads.
Deploy App Node Client: Each application developer needs to run their own node by attaching their client to a staking contract. This allows them to participate in making the network secure through consensus and keeping a check on state transitions. The app node client acts as a bridge between the application and the AXES network. It handles tasks such as receiving prompt requests, executing the application logic, and submitting responses back to the network.
Configuring Application Endpoints
AXES supports multiple communication protocols for your AI application. You can configure your application to expose endpoints using gRPC, REST API, or a canvas graphic user interface (GUI).
gRPC Configuration
To enable gRPC communication for your application:
Associate your application with the application node client using the AXES platform's tools.
Define the necessary gRPC endpoints and services in your application code.
Manage your gRPC settings through the "Manage Client" option in the Dev Dashboard.
REST API Configuration
To set up REST API endpoints for your application:
Use the advanced settings in the Dev Dashboard to define your API routes and endpoints.
Optionally, you can utilize tools like Swagger to document and manage your API.
Specify the allowed API routes and configure any necessary authentication or authorization mechanisms.
Canvas GUI Configuration
To create a canvas GUI for your application:
Use the
axes.connect.canvas()
method to invoke a GUI interface between your application and users.Customize the canvas object to include desired functionalities supported by web browsers, such as media files, spreadsheet files, code repositories, or code editors.
Note that running a canvas GUI requires an always-on VM instance, which incurs additional costs.
Publishing and Monetization
Once your AI application is configured and tested, you can publish it on the AXES platform and explore monetization opportunities:
Set Pricing: Determine the pricing model for your application. You can offer free trials, freemium options, or set specific fees for different request types or usage tiers.
Publish to Marketplace: Submit your application for review and approval. Once approved, your application will be listed on the AXES marketplace, making it discoverable to users.
Monetization Options: AXES provides various monetization channels, such as usage-based billing, subscriptions, or one-time purchases. You can also participate in revenue-sharing programs offered by AXES.
Withdraw Earnings: Monitor your application's performance and earnings through the Dev Dashboard. You can withdraw your earnings to your designated bank account or crypto wallet, depending on your preference.
Engaging with Users
Engage with your application's users to gather valuable feedback and insights:
User Feedback: Encourage users to provide ratings, reviews, and feedback for your application. Regularly monitor and respond to user comments to address any concerns or suggestions.
Analytics: Utilize the analytics tools provided by AXES to track your application's usage, user engagement, and performance metrics. Analyze this data to make data-driven decisions and identify areas for improvement.
Updates and Enhancements: Continuously update and enhance your application based on user feedback and market demands. Regularly release new features, bug fixes, and performance optimizations to keep your users engaged and satisfied.
Getting Support
If you need any assistance or have questions while developing your AI apps on AXES, reach out to our dedicated support channels:
Documentation: Refer to the comprehensive documentation available on the Axes Hub platform for detailed information on APIs, smart contracts, best practices, and tutorials.
Community Forums: Engage with the AXES developer community through forums and discussion boards. Share your experiences, seek advice, and collaborate with other developers.
Last updated