Welcome to the Credmark Model Framework documentation!

Credmark Model Framework is a Python library building models that run on the Credmark Data Platform.

This site gives you some deep technical details of the CMF and its components. For an introduction and simple how-to-guide, please head over to the Github Readme for the CMF.

Note

This project is under active development.

Contents

• CLI credmark-dev
  • help command
  • create command
  • run command
  • list command
  • describe command
  • test command
  • version command
  • Interactive Model Console
    • Using the Console
      • Get current context block number
      • Get a block number for a timestamp
      • Query the ledger
      • Get info on a model
      • Run a model
        • Run a model with parameters
        • Run a model and get a DTO result
      • Switch context to an earlier block number
    • Console Configuration
• Model Framework Core Components
  • Model Class
  • Data Transfer Object (DTO)
    • Model Error Detail DTO [Advanced Topic]
  • Data Classes
  • Model Context
    • Calling Other Models
      • context.models
      • context.run_model()
    • Web3
    • Contract
    • Ledger
    • Block number
    • Historical Utility
• Error handling
  • ModelBaseError
  • ModelDataError
    • Raising ModelDataError Errors
  • ModelInputError
  • Logging
• Testing Models
  • Unit Testing
    • Creating Tests
    • Running Tests
  • Mocks
    • Mock Configuration
    • Generating Mocks
      • Removing Top-Level Generated Mocks
    • Testing with Mocks
    • Running with Mocks
    • Example Using Mocks
      • Example Unit Test
• Framework Reference
  • credmark
• Credmark API Client
  • Install
  • Configuration
  • CLI Usage
  • Run a Model
  • SDK Usage