Welcome to the Citrine Python client documentation!

This site documents the Python SDK for the Citrine Platform. It provides utilities to upload and manage data and design materials using Sequential Learning. See the getting started guide for a high-level introduction. The workflows section documents how to configure and run artificial intelligence (AI) workflows for materials research and development.

Installation

The latest release can be installed via pip:

pip install citrine

or a specific version can be installed, for example:

pip install citrine==3.0.0

Table of Contents

• 1. Getting Started
  • 1.1. Overview
  • 1.2. Connecting to the Citrine Platform
  • 1.3. Managing Resources
  • 1.4. Teams
  • 1.5. Projects
  • 1.6. Datasets
  • 1.7. Data Model Overview
  • 1.8. AI Engine Overview
  • 1.9. Code Examples
  • 1.10. Request Throttling
• 2. GEMD Data Model
  • 2.1. Creating Data Model Objects
  • 2.2. Identifying Data Model Objects
  • 2.3. Registering Data Model Objects
  • 2.4. Finding Data Model Objects
  • 2.5. Updating Data Model Objects
  • 2.6. Referencing Data Model Objects
  • 2.7. Material History
  • 2.8. Validating Data Model Objects
• 3. Data Extraction
  • 3.1. Defining rows and columns
  • 3.2. Defining tables
  • 3.3. Previewing tables
  • 3.4. Building and downloading tables
  • 3.5. Available Row Definitions
  • 3.6. Available Variable Definitions
  • 3.7. Available Column Definitions
  • 3.8. Compatibility with AI Engine
• 4. AI Engine
  • 4.1. Getting Started
  • 4.2. Descriptors
  • 4.3. Predictors
  • 4.4. Design Spaces
  • 4.5. Design Workflows
  • 4.6. Scores
  • 4.7. Data Sources
  • 4.8. Predictor Reports
  • 4.9. Predictor Evaluation Workflows
  • 4.10. [ALPHA] Generative Design Execution
  • 4.11. AI Engine Code Examples
• 5. Formulations Example
  • 5.1. Example Raw Data
  • 5.2. Ingesting Data
  • 5.3. Building a Table
  • 5.4. Training a Predictor
  • 5.5. Defining a Design Space
  • 5.6. Proposing New Formulation Candidates
• 6. FAQ
  • 6.1. Prohibited Data Patterns
  • 6.2. Migrating to 3.0
  • 6.3. Migrating to Use Data Manager
• 7. API Reference
  • 7.1. citrine package

Indices and tables

• Index

• Module Index

• Search Page