Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Model boundaries #81

Open
jdsika opened this issue Apr 8, 2024 · 1 comment
Open

Documentation: Model boundaries #81

jdsika opened this issue Apr 8, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@jdsika
Copy link

jdsika commented Apr 8, 2024

The readme contains the requirements regarding the documentation of the model. Currently the boundaries in which the model is allowed to operate and its limitations are not described.

@jdsika jdsika added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Apr 8, 2024
@localhorst87
Copy link

Imho we must distinguish between different classes of boundaries:

  • The model boundaries are strictly restrictive (i.e., moving outside these boundaries causes runtime errors due to singularities or unexpected physical behaviour), for instance "the model MUST be instantiated from standstill", "the model MUST NOT be used for reverse drive", etc. --> model boundaries should be moved to the future specification

  • The model boundaries represent permissive behaviour (i.e., moving outside these boundaries is possible from runtime point-of-view, but is not supported due to the modeling approach), for instance "the sensor model does not support identification of static objects", "the model does not support accelerations above 0.4g" --> model boundaries could be stated in the documentation (up to discussion)

  • Validated model boundaries (i.e., the boundaries have been validated in the test pipeline, for example by comparing them to reference data) should be added as extra information in the documentation, like "the model supports velocities from 0 to 130 km/h (Credibility Level 2)"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
Development

No branches or pull requests

2 participants