huawei-noah/SMARTS

Convert engine constants to configuration

Open

#1,854 opened on Feb 10, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (220 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (1,129 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. The current SMARTS engine does not allow for configuration of important features. We would like to go through parts of the engine and convert settings to

Describe the solution you'd like Go through parts of the engine and replace areas where configuration is useful:

  • Add an engine configuration document to readthedocs
    • List out what features have been made configurable
    • List out where configuration can be found
  • Update configuration

Some examples of useful configuration are: SMARTS_SENSOR_WORKER_COUNT,

Additional context See the PR where the utility was added for additional context: #1828

Contributor guide

Research direction
Investigate the SMARTS engine codebase to identify constants that can be made configurable, such as SMARTS SENSOR WORKER COUNT. Look at existing configuration patterns (e.g., from PR #1828) and propose a design for a configuration file or environment variables. Update documentation on readthedocs accordingly.
Tech stack
python
Domain
backendai
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60