Getting Started

Welcome to the platform! This guide will help you create an account, publish your first model, and explore datasets.

1. Create an Account

Start by creating a free account. You'll get access to public repositories and basic features.

To sign up:

  1. Click the "Sign Up" button in the top navigation
  2. Enter your email, username, and password
  3. Verify your email address (check your inbox)
  4. Complete your profile

2. Explore the Model Hub

Browse thousands of pre-trained models for various tasks including:

  • Text Generation - Language models for content creation
  • Image Classification - Computer vision models
  • Object Detection - Identify and locate objects in images
  • Audio Processing - Speech recognition and audio generation
  • And more...

3. Create Your First Model Repository

Once you have an account, you can create your own model repository.

Steps to create a model:

  1. Click "New Model" from your dashboard
  2. Enter a unique name for your model
  3. Choose visibility (public or private)
  4. Add tags and select the task type
  5. Write a README describing your model
  6. Upload your model files

Example API request to create a model:

POST /api/models
Authorization: Bearer <your-token>
Content-Type: application/json

{
  "name": "my-awesome-model",
  "namespace": "your-username",
  "visibility": "public",
  "task": "text-generation",
  "tags": ["nlp", "transformers"],
  "description": "A fine-tuned model for text generation"
}

4. Explore Datasets

Datasets are essential for training and evaluating models. Browse our collection or upload your own.

Dataset features:

  • Interactive data viewer with pagination
  • Schema inspection
  • Sample rows preview
  • Download in multiple formats
  • Version control

5. Use the API

All platform features are accessible via our REST API. Use any HTTP client or our official SDKs.

Authentication:

# Sign in to get your access token
POST /api/auth/signin
{
  "email": "user@example.com",
  "password": "your-password"
}

# Use the token in subsequent requests
GET /api/auth/me
Authorization: Bearer <your-access-token>