Project name not set

Contents:

  • Introduction
    • Framework Overview
    • Key Features
    • Value Proposition
    • Installation
  • Getting Started
    • Prerequisites
    • Quick Start: Robertson System Example
      • 1. Create Session Structure
      • 2. Prepare Input Files
      • 3. Run the Three-Stage Workflow
        • Stage 1: Generate Code Skeleton
        • Stage 2: Validate Your Setup
        • Stage 3: Parameter Estimation
    • Expected Results
    • Customizing for Your Problem
    • Troubleshooting
      • Common Issues
      • Getting Help
    • Next Steps
  • API Reference
    • Main Scripts
      • create_user_model()
      • check_input()
      • run_driver()
    • Core Classes
      • ProblemObjectBase
        • ProblemObjectBase.params_to_fit_names
        • ProblemObjectBase.y0
        • ProblemObjectBase.t_eval
        • ProblemObjectBase.dataset
        • ProblemObjectBase.num_columns_to_fit
        • ProblemObjectBase.fixed_params_names
        • ProblemObjectBase.fixed_param_values
        • ProblemObjectBase.__init__()
        • ProblemObjectBase.compute_all_losses()
        • ProblemObjectBase.compute_loss()
        • ProblemObjectBase.integrate_system()
        • ProblemObjectBase.plot_result()
      • CreatedClass
        • CreatedClass.__init__()
        • CreatedClass._compute_all_losses()
        • CreatedClass._compute_loss()
        • CreatedClass.set_is_logscale()
        • CreatedClass.set_max_limit()
        • CreatedClass.set_min_limit()
        • CreatedClass.write_problem_result()
      • fit_equation_system()
      • fit_generic_system()
      • get_input_reader()
      • optimize_function()
    • LLM Integration
      • LLMBase
        • LLMBase.name
        • LLMBase.vendor
        • LLMBase.model
        • LLMBase.API_key
        • LLMBase.client
        • LLMBase.check_generated_files()
        • LLMBase.check_model_output_inputcheck()
        • LLMBase.generate_system()
        • LLMBase.generate_user_model()
        • LLMBase.init_client()
        • LLMBase.set_API_key()
      • OpenAI_model
        • OpenAI_model.input_file_path
        • OpenAI_model.reference_file_paths
        • OpenAI_model.api_key_string
        • OpenAI_model.dev_instr_filename
        • OpenAI_model.role
        • OpenAI_model.vendor
        • OpenAI_model.model
        • OpenAI_model.vector_store_ids
        • OpenAI_model.dev_instructions_filename
        • OpenAI_model.dev_instr
        • OpenAI_model.client
        • OpenAI_model.__init__()
        • OpenAI_model._check_generated_files()
        • OpenAI_model._check_model_output_inputcheck()
        • OpenAI_model._generate_system()
        • OpenAI_model._generate_user_model()
        • OpenAI_model._set_developer_instructions()
Project name not set
  • OSParamFitting API Documentation
  • View page source

OSParamFitting API Documentation

Contents:

  • Introduction
    • Framework Overview
    • Key Features
    • Value Proposition
    • Installation
  • Getting Started
    • Prerequisites
    • Quick Start: Robertson System Example
      • 1. Create Session Structure
      • 2. Prepare Input Files
      • 3. Run the Three-Stage Workflow
    • Expected Results
    • Customizing for Your Problem
    • Troubleshooting
      • Common Issues
      • Getting Help
    • Next Steps
  • API Reference
    • Main Scripts
      • create_user_model()
      • check_input()
      • run_driver()
    • Core Classes
      • ProblemObjectBase
      • CreatedClass
      • fit_equation_system()
      • fit_generic_system()
      • get_input_reader()
      • optimize_function()
    • LLM Integration
      • LLMBase
      • OpenAI_model
Next

© Copyright .

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