fixed some version comments

nasa / prog_models

The NASA Prognostic Model Package is a Python framework focused on defining and building models for prognostics (computation of remaining useful life) of engineering systems, and provides a set of prognostics models for select components developed within this framework, suitable for use in prognostics applications for these components.

123 stars 50 forks source link

fixed some version comments #573

Closed mstraut closed 1 year ago

mstraut commented 1 year ago

Fixed the version comments. There were some missing.

github-actions[bot] commented 1 year ago

Thank you for opening this PR. Each PR into dev requires a code review. For the code review, look at the following:

[ ] Reviewer (someone other than author) should look for bugs, efficiency, readability, testing, and coverage in examples (if relevant).
[ ] Ensure that each PR adding a new feature should include a test verifying that feature.
[ ] All errors from static analysis must be resolved.
[ ] Review the test coverage reports (if there is a change) - will be added as comment on PR if there is a change
[ ] Review the software benchmarking results (if there is a change) - will be added as comment on PR
[ ] Any added dependencies are included in requirements.txt, setup.py, and dev_guide.rst (this document)
[ ] All warnings from static analysis must be reviewed and resolved - if deemed appropriate.

github-actions[bot] commented 1 year ago

Benchmarking Results From:	Test	Time (s)
import main	0.11120069999999993
import thrown object	0.5076976
model initialization	0.15531950000000005
set noise	0.6887893
simulate	0.5002303000000001
simulate with saving	1.4073088999999999
simulate with saving, dt	1.8331938999999995
simulate with printing results, dt	2.288055700000001
Plot results	13.967819
Metrics	0.0434127999999987
Surrogate Model Generation	2.1760717000000014
surrogate sim	1.3697374999999994
surrogate sim, dt	3.6964539999999992

To:	Test	Time (s)
import main	0.12342399999999998
import thrown object	0.5110984999999999
model initialization	0.1568826999999997
set noise	0.6835216000000002
simulate	0.4969309000000002
simulate with saving	1.4044145999999995
simulate with saving, dt	1.8098521000000005
simulate with printing results, dt	2.2674190999999997
Plot results	13.9845693
Metrics	0.042651200000001666
Surrogate Model Generation	2.1940849
surrogate sim	1.3631288999999995
surrogate sim, dt	3.674010599999999

codecov-commenter commented 1 year ago

Codecov Report

Merging #573 (9c05b69) into master (db91bfd) will decrease coverage by 0.53%. The diff coverage is 77.85%.

@@            Coverage Diff             @@
##           master     #573      +/-   ##
==========================================
- Coverage   85.03%   84.50%   -0.53%     
==========================================
  Files          45       45              
  Lines        3481     3504      +23     
==========================================
+ Hits         2960     2961       +1     
- Misses        521      543      +22

Impacted Files	Coverage Δ
src/prog_models/composite_model.py	`89.93% <ø> (ø)`
src/prog_models/ensemble_model.py	`100.00% <ø> (ø)`
src/prog_models/linear_model.py	`95.00% <ø> (ø)`
src/prog_models/loading/gaussian_wrapper.py	`45.45% <ø> (ø)`
src/prog_models/loading/moving_average.py	`33.33% <ø> (ø)`
src/prog_models/loading/piecewise.py	`100.00% <ø> (ø)`
src/prog_models/models/aircraft_model/aircraft.py	`100.00% <ø> (ø)`
...odels/aircraft_model/vehicles/aero/aerodynamics.py	`100.00% <ø> (ø)`
src/prog_models/sim_result.py	`88.39% <ø> (ø)`
src/prog_models/utils/containers.py	`87.00% <ø> (-2.00%)`	:arrow_down:
... and 26 more

... and 1 file with indirect coverage changes

github-actions[bot] commented 1 year ago

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.1204999
import thrown object	0.49488049999999983
model initialization	0.1545665999999999
set noise	0.6703329
simulate	0.4976955999999997
simulate with saving	1.3924159
simulate with saving, dt	1.8043302000000008
simulate with printing results, dt	2.2516115999999995
Plot results	14.2887211
Metrics	0.04199660000000094
Surrogate Model Generation	2.172781799999999
surrogate sim	1.3618530999999976
surrogate sim, dt	3.6639859

To:

Test	Time (s)
import main	0.12279269999999998
import thrown object	0.4969557
model initialization	0.1537440000000001
set noise	0.6670319999999998
simulate	0.49562209999999984
simulate with saving	1.3902635
simulate with saving, dt	1.8005876
simulate with printing results, dt	2.2311325999999996
Plot results	14.3305344
Metrics	0.04213400000000078
Surrogate Model Generation	2.1672557999999995
surrogate sim	1.3591619999999978
surrogate sim, dt	3.6691099000000023

teubert commented 1 year ago

This PR does not change any logical lines of code. Instead, it updates the comments and therefore the documentation generated from these comments.

Therefore, it is determined that this change does not require a new version/hotfix and it is approved for merge into master.

github-actions[bot] commented 1 year ago

Benchmarking Results [Update] From:	Test	Time (s)
import main	0.17831020000000009
import thrown object	0.6393411
model initialization	0.1903337999999999
set noise	0.8385546000000001
simulate	0.5887537000000003
simulate with saving	1.6888534000000002
simulate with saving, dt	2.1600048999999997
simulate with printing results, dt	2.6969936
Plot results	17.4985375
Metrics	0.04650309999999891
Surrogate Model Generation	2.6111030999999976
surrogate sim	1.7139257999999984
surrogate sim, dt	4.438685800000002

To:

Test	Time (s)
import main	0.1705641
import thrown object	0.6406160000000001
model initialization	0.19140889999999988
set noise	0.8459442999999998
simulate	0.5954535999999999
simulate with saving	1.6740143000000005
simulate with saving, dt	2.1236249999999988
simulate with printing results, dt	2.654240099999999
Plot results	17.6184592
Metrics	0.046113500000000585
Surrogate Model Generation	2.5973026999999966
surrogate sim	1.702971699999999
surrogate sim, dt	4.3909582