LogoLogo
  • Welcome to Gretel!
  • Gretel Basics
    • Getting Started
      • Quickstart
      • Blueprints
      • Use Case Examples
      • Environment Setup
        • Console
        • SDK
      • Projects
      • Inputs and Outputs
      • Gretel Connectors
        • Object Storage
          • Amazon S3
          • Google Cloud Storage
          • Azure Blob
        • Database
          • MySQL
          • PostgreSQL
          • MS SQL Server
          • Oracle Database
        • Data Warehouse
          • Snowflake
          • BigQuery
          • Databricks
        • Gretel Project
    • Release Notes
      • Platform Release Notes
        • May 2025
        • April 2025
        • March 2025
        • February 2025
        • January 2025
        • December 2024
        • November 2024
        • October 2024
        • September 2024
        • August 2024
        • July 2024
        • June 2024
      • Console Release Notes
        • January 2025
        • December 2024
        • November 2024
        • October 2024
        • September 2024
        • August 2024
      • Python SDKs
  • Create Synthetic Data
    • Gretel Safe Synthetics
      • Transform
        • Reference
        • Examples
        • Supported Entities
      • Synthetics
        • Gretel Tabular Fine-Tuning
        • Gretel Text Fine-Tuning
        • Gretel Tabular GAN
        • Benchmark Report
        • Privacy Protection
      • Evaluate
        • Synthetic Quality & Privacy Report
        • Tips to Improve Synthetic Data Quality
        • Data Privacy 101
      • SDK
    • Gretel Data Designer
      • Getting Started with Data Designer
      • Define your Data Columns
        • Column Types
        • Add Constraints to Columns
        • Custom Model Configurations
        • Upload Files as Seeds
      • Building your Dataset
        • Seeding your Dataset
        • Generating Data
      • Generate Realistic Personal Details
      • Structured Outputs
      • Code Validation
      • Data Evaluation
      • Magic Assistance
      • Using Jinja Templates
  • Gretel Playground [Legacy]
    • Getting Started
    • Prompts Tips & Best Practices
    • FAQ
    • SDK Examples
    • Tutorials
    • Videos
    • Gretel Playground [Legacy] Inference API
    • Batch Job SDK
  • Reference
    • Gretel's Python Client
    • Gretel’s Open Source Synthetic Engine
    • Gretel’s REST API
    • Homepage
    • Model Suites
Powered by GitBook
On this page
  • Reading Project Artifacts
  • Inputs
  • Outputs
  • Writing Project Artifacts
  • Inputs
  • Outputs
  • Examples

Was this helpful?

Export as PDF
  1. Gretel Basics
  2. Getting Started
  3. Gretel Connectors

Gretel Project

Access artifacts in your project.

Gretel Workflows can read from and write to your Gretel Project. The actions below can be particularly useful alternatives if you have local data you want to run through a workflow, or don't have a destination to write output data to.

Reading Project Artifacts

The read_project_artifact action can be used to read in existing Gretel Project Artifacts as inputs to other actions.

Inputs

project_id

The project id the artifact is located in.

artifact_id

The id of the artifact to read.

Outputs

dataset

A dataset with exactly one item (the project artifact) represented as both a file and table.

Writing Project Artifacts

The write_project_artifact action can be used to write an action output to a Gretel Project.

Inputs

project_id

The project to create the artifact in.

artifact_name

The name of the artifact.

data

Reference to a data handle.

Outputs

None.

Examples

Train a Gretel Model from an existing project artifact and write the output to your project.

name: train-model-from-artifact

actions:
  - name: read-artifact
    type: read_project_artifact
    config:
      project_id: proj_1
      artifact_id: art_1

  - name: train-model
    type: gretel_model
    input: read-artifact
    config:
      project_id: proj_1
      model: synthetics/default
      training_data: "{outputs.read-artifact.dataset.files.data}"

  - name: write-artifact
    type: write_project_artifact
    config:
      project_id: proj_1
      artifact_name: my_output
      data: "{outputs.train-model.dataset.files.data}"
PreviousDatabricksNextRelease Notes

Last updated 11 months ago

Was this helpful?