​

Installing the NomadicML SDK

This guide covers the installation and basic configuration of the NomadicML Python SDK.

​

Prerequisites

• Python 3.8 or higher
• pip (Python package installer)

​

Installation Options

​

Standard Installation

Install the SDK directly from PyPI:

pip install nomadicml

This is the recommended method for most users.

​

Basic Configuration

Once you have the SDK installed and your API key, you can initialize the client:

from nomadicml import NomadicML

# Initialize with default settings
client = NomadicML(api_key="your_api_key")

# Or with custom configuration
client = NomadicML(
    api_key="your_api_key",
    base_url="https://custom-deployment.example.com",  # Optional: Custom API endpoint
    timeout=60,  # Optional: Custom timeout in seconds
    collection_name="custom_collection"  # Optional: Custom Firestore collection
)

​

Verifying Installation

To verify that everything is set up correctly:

# Check authentication
try:
    auth_info = client.verify_auth()
    print("Authentication successful:", auth_info)
except Exception as e:
    print("Authentication failed:", e)

​

Troubleshooting

For authentication issues, see the Authentication Guide.

For package conflicts, try installing in a virtual environment or upgrading to the latest version with pip install --upgrade nomadicml.

​

Next Steps

Now that you have the SDK installed and configured, you can: