CorePlexML Logo

User Manuals

  • CorePlexML User Manuals
    • CorePlexML User Manual (English)
      • 1. Account Onboarding
        • Goal
        • Who should read this
        • Preconditions
        • Step-by-step
        • Functional validation checklist
        • Expected result
        • Common errors and recovery
        • Screenshot
      • 2. Navigation and Workspace
        • Goal
        • Workspace semantics
        • Step-by-step
        • Functional validation checklist
        • Expected result
        • Common errors and recovery
        • Screenshot
      • 3. Projects and Datasets
        • Goal
        • Preconditions
        • Create a project
        • Upload a dataset
        • Validate dataset quality
        • Functional validation checklist
        • Expected result
        • Common errors and recovery
        • Screenshots
      • 4. Dataset Builder AI
        • Goal
        • What this module must do
        • Run a realistic conversation
        • If output is not what you expect
        • Functional validation checklist
        • Expected result
        • Common errors and recovery
        • Screenshot
      • 5. Experiments, Models, Predictions
        • Goal
        • Create an experiment
        • Review results and model registry
        • Run predictions
        • Functional validation checklist
        • Expected result
        • Common errors and recovery
        • Screenshots
      • 6. MLOps and A/B Testing
        • Goal
        • Create a deployment
        • Monitor deployment
        • Run A/B test
        • Functional validation checklist
        • Expected result
        • Common errors and recovery
        • Screenshots
      • 7. Privacy and SynthGen
        • Goal
        • Privacy workflow
        • SynthGen workflow
        • Data quality and parity checks
        • Functional validation checklist
        • Expected result
        • Common errors and recovery
        • Screenshots
      • 8. Teams, Billing, Admin, Troubleshooting
        • Goal
        • Teams management
        • Billing and plan lifecycle
        • Admin controls
        • Functional validation checklist
        • Expected result
        • Troubleshooting quick playbook
        • Screenshot
    • Manual de Usuario CorePlexML (ES)
      • 1. Cuenta y Onboarding
        • Objetivo
        • Para quien es
        • Precondiciones
        • Paso a paso
        • Checklist de validacion funcional
        • Resultado esperado
        • Errores comunes y recuperacion
        • Imagen
      • 2. Navegacion y Workspace
        • Objetivo
        • Semantica del workspace
        • Paso a paso
        • Checklist de validacion funcional
        • Resultado esperado
        • Errores comunes y recuperacion
        • Imagen
      • 3. Proyectos y Datasets
        • Objetivo
        • Precondiciones
        • Crear proyecto
        • Subir dataset
        • Validar calidad de datos
        • Checklist de validacion funcional
        • Resultado esperado
        • Errores comunes y recuperacion
        • Imagenes
      • 4. Dataset Builder AI
        • Objetivo
        • Que debe cumplir este modulo
        • Flujo conversacional realista
        • Si el resultado no es el esperado
        • Checklist de validacion funcional
        • Resultado esperado
        • Errores comunes y recuperacion
        • Imagen
      • 5. Experimentos, Modelos, Predicciones
        • Objetivo
        • Crear experimento
        • Revisar resultados y modelos
        • Ejecutar predicciones
        • Checklist de validacion funcional
        • Resultado esperado
        • Errores comunes y recuperacion
        • Imagenes
      • 6. MLOps y AB Testing
        • Objetivo
        • Crear deployment
        • Monitorear deployment
        • Ejecutar AB test
        • Checklist de validacion funcional
        • Resultado esperado
        • Errores comunes y recuperacion
        • Imagenes
      • 7. Privacy y SynthGen
        • Objetivo
        • Flujo de Privacy
        • Flujo de SynthGen
        • Checks de calidad y paridad
        • Checklist de validacion funcional
        • Resultado esperado
        • Errores comunes y recuperacion
        • Imagenes
      • 8. Teams, Billing, Admin y Troubleshooting
        • Objetivo
        • Gestion de equipos
        • Billing y ciclo de plan
        • Controles Admin
        • Checklist de validacion funcional
        • Resultado esperado
        • Playbook rapido de recuperacion
        • Imagen
    • Manual do Usuario CorePlexML (PT-BR)
      • 1. Conta e Onboarding
        • Objetivo
        • Para quem e
        • Precondicoes
        • Passo a passo
        • Checklist de validacao funcional
        • Resultado esperado
        • Erros comuns e recuperacao
        • Imagem
      • 2. Navegacao e Workspace
        • Objetivo
        • Semantica do workspace
        • Passo a passo
        • Checklist de validacao funcional
        • Resultado esperado
        • Erros comuns e recuperacao
        • Imagem
      • 3. Projetos e Datasets
        • Objetivo
        • Precondicoes
        • Criar projeto
        • Upload de dataset
        • Validar qualidade de dados
        • Checklist de validacao funcional
        • Resultado esperado
        • Erros comuns e recuperacao
        • Imagens
      • 4. Dataset Builder AI
        • Objetivo
        • O que este modulo deve cumprir
        • Fluxo conversacional realista
        • Se o resultado nao for o esperado
        • Checklist de validacao funcional
        • Resultado esperado
        • Erros comuns e recuperacao
        • Imagem
      • 5. Experimentos, Modelos e Predicoes
        • Objetivo
        • Criar experimento
        • Revisar resultados e registro de modelos
        • Executar predicoes
        • Checklist de validacao funcional
        • Resultado esperado
        • Erros comuns e recuperacao
        • Imagens
      • 6. MLOps e AB Testing
        • Objetivo
        • Criar deployment
        • Monitorar deployment
        • Executar AB test
        • Checklist de validacao funcional
        • Resultado esperado
        • Erros comuns e recuperacao
        • Imagens
      • 7. Privacy e SynthGen
        • Objetivo
        • Fluxo de Privacy
        • Fluxo de SynthGen
        • Checks de qualidade e paridade
        • Checklist de validacao funcional
        • Resultado esperado
        • Erros comuns e recuperacao
        • Imagens
      • 8. Teams, Billing, Admin e Troubleshooting
        • Objetivo
        • Gestao de times
        • Billing e ciclo de plano
        • Controles Admin
        • Checklist de validacao funcional
        • Resultado esperado
        • Playbook rapido de recuperacao
        • Imagem

Getting Started

  • Getting Started
    • Core Concepts
      • Projects
      • Datasets & Versions
      • Experiments
      • Models
      • Deployments (MLOps)
      • Reports
      • Enterprise Modules
    • Next Steps
  • Authentication
    • API Key Authentication
      • Creating an API Key Programmatically
      • API Key Scopes
    • Session Authentication
    • Error Responses
  • Quick Start
    • Prerequisites
    • 1. Create a Project
    • 2. Upload a Dataset
    • 3. Inspect the Schema
    • 4. Run an AutoML Experiment
    • 5. Poll for Completion
    • 6. List Trained Models
    • 7. Make a Prediction
    • 8. Deploy to Production
    • Next Steps

Developer Guides

  • Developer Guides
    • End-to-End ML Pipeline
      • Overview
      • Working with Projects
        • Creating a Project
        • Listing Projects
        • Sharing a Project
      • Data Ingestion
        • Uploading a CSV
        • Inspecting Column Schema
        • Downloading Data
      • AutoML Training
        • Supported Algorithms
        • Evaluation Metrics
        • Experiment Configuration
        • Classification Example
        • Regression Example
        • Waiting for Completion
      • Model Evaluation
        • Leaderboard
        • Model Details
        • Feature Importance
        • Ad-hoc Predictions
      • Report Generation
    • Privacy Suite
      • Overview
      • Step 1: Create a Privacy Policy
      • Step 2: Add Detection Rules
        • Listing Available PII Types
      • Step 3: Create a Scan Session
      • Step 4: Run Detection
      • Step 5: Transform (Anonymize)
      • Step 6: Download Anonymized Data
      • Compliance Validation
      • Export Privacy Report
      • SDK Example
    • Synthetic Data Generation
      • Overview
      • Training a Model
        • Choosing a Model Type
        • Training Configuration
      • Generating Synthetic Data
        • Conditional Generation
        • Streaming Large Datasets
      • Downloading Synthetic Data
      • Quality Metrics
      • SynthGen Report
      • SDK Example
    • MLOps & Model Serving
      • Overview
      • Creating a Deployment
        • Listing Deployments
      • Making Predictions
        • Single Prediction
        • Batch Predictions
        • Feature Contributions (SHAP)
      • Promoting and Rolling Back
        • Promote to Production
        • Rollback
        • Deactivate
      • Inference Logging
      • Data Drift Detection
      • Alerting
      • Auto-Retraining
      • Deployment with Privacy
      • SDK Example
    • What-If Analysis
      • Overview
      • Creating a Session
        • Getting the Feature Schema
      • Adding Scenarios
      • Running Scenarios
      • Comparing Results
      • Listing Sessions
      • SDK Example

Python SDK

  • Python SDK
    • Installation
    • Quick Initialization
    • Key Concepts
      • Resources
      • Job Polling
      • Error Handling
      • Authentication
    • Version Compatibility
    • Contents
      • Quick Start
        • Prerequisites
        • Step 1 – Install and Configure
        • Step 2 – Create a Project
        • Step 3 – Upload a Dataset
        • Step 4 – Create an Experiment (Classification)
        • Step 5 – Wait for Training
        • Step 6 – List Models and Get the Best One
        • Step 7 – Deploy to Staging
        • Step 8 – Make Predictions via Deployment
        • Step 9 – Generate a Report
        • Step 10 – Clean Up
        • Error Handling
        • Next Steps
      • CorePlexMLClient
        • Constructor
        • Resource Attributes
        • Connection Configuration
        • Authentication
        • Autodoc Reference
      • Resource Reference
        • ProjectsResource
        • DatasetsResource
        • ExperimentsResource
        • ModelsResource
        • DeploymentsResource
        • ReportsResource
        • PrivacyResource
        • SynthGenResource
        • StudioResource
      • Exceptions
        • Exception Hierarchy
        • Autodoc Reference
        • CorePlexMLError
        • AuthenticationError
        • NotFoundError
        • ValidationError
        • Error Handling Patterns
      • Advanced Usage
        • Job Polling Patterns
        • Batch Predictions
        • Dataset Versions Workflow
        • Privacy Suite Workflow
        • SynthGen Workflow
        • What-If Analysis (Studio) Workflow
        • Error Handling Patterns
        • Timeout Configuration
        • Working with Large Datasets
        • Logging
      • Example Scripts
        • 01 – Quick Start
        • 02 – Batch Predictions
        • 03 – Experiment Comparison
        • 04 – Privacy Workflow
        • 05 – Synthetic Data Generation
        • 06 – Model Monitoring
        • 07 – What-If Analysis
        • 08 – Report Generation
        • Running the Examples

REST API Reference

  • API Reference
    • Base URL
    • Authentication
    • Common Response Format
    • Pagination
    • Content Types
    • Rate Limiting
    • File Upload Limits
    • Error Handling
    • PDF Download
      • Authentication
        • Register User
        • Login
        • Logout
        • Get Current User
        • Create API Key
        • List API Keys
        • Revoke API Key
        • Forgot Password
        • Reset Password
      • Projects API
        • List Projects
        • Create Project
        • Get Project
        • Update Project
        • Delete Project
        • List Members
        • Add Member
        • Activity Timeline
        • Export Project
      • Datasets API
        • Upload Dataset
        • List Datasets
        • Get Dataset Detail
        • Get Column Schema
        • Download Dataset
        • Statistical Analysis
        • Data Quality Report
        • Dataset Lineage
        • Delete Dataset
        • List Versions
        • Upload New Version
        • Compare Versions
        • Get Dataset Version
      • Experiments API
        • Create Experiment
        • List Experiments
        • Get Experiment Detail
        • Get Experiment Status
        • Get Training Logs
        • Explainability
        • Set Best Model
        • Delete Experiment
      • Models API
        • List Models
        • Get Model Detail
        • Get Hyperparameters
        • Model Explainability
        • Single/Batch Prediction
        • Batch Predict from File
        • Delete Model
      • Deployments API
        • Create Deployment
        • List Deployments
        • Get Deployment Detail
        • Predict via Deployment
        • Promote Deployment
        • Rollback Deployment
        • Deactivate Deployment
        • Drift Metrics
        • Run Drift Detection
        • Inference Logs
        • Deployment Lifecycle Example
      • Reports API
        • Create Report
        • List Reports
        • Get Report Detail
        • View Report Inline
        • Download Report
      • Privacy Suite API
        • Create Policy
        • List Policies
        • Get Policy
        • Update Policy
        • Delete Policy
        • Create Detection Rule
        • List Rules
        • Create Session
        • List Sessions
        • Get Session Detail
        • Run PII Detection
        • Apply Anonymization
        • Detection Results
        • Download Anonymized Data
        • Generate Privacy Report
        • List PII Types
        • List Actions
        • List Compliance Profiles
        • Full Workflow Example
        • Supported PII Types
        • Transformation Actions Reference
        • Compliance Profiles
        • Detection Confidence Levels
      • SynthGen API
        • Create Model
        • List Models
        • Get Model Detail
        • Generate Synthetic Data
        • Delete Model
        • List Jobs
        • Get Job Detail
        • Download Synthetic Data
        • List Model Types
        • Full Workflow Example
      • ML Studio (What-If) API
        • Create Session
        • List Sessions
        • Get Session Detail
        • Get Feature Schema
        • Create Scenario
        • Run Scenario
        • Compare Scenarios
        • End-to-End What-If Example
      • Error Handling
        • Error Response Format
        • HTTP Status Codes
        • Rate Limiting
        • Common Error Scenarios
        • Retry Strategy
CorePlexML
  • Overview: module code

All modules for which code is available

  • coreplexml.client
  • coreplexml.datasets
  • coreplexml.deployments
  • coreplexml.exceptions
  • coreplexml.experiments
  • coreplexml.models
  • coreplexml.privacy
  • coreplexml.projects
  • coreplexml.reports
  • coreplexml.studio
  • coreplexml.synthgen

© Copyright 2025-2026, Intellicore TI SpA.

Built with Sphinx using a theme provided by Read the Docs.