Cloud-CV / EvalAI

:cloud: :rocket: :bar_chart: :chart_with_upwards_trend: Evaluating state of the art in AI
https://eval.ai
Other
1.77k stars 787 forks source link

Add documentation for auto-scaling and auto-cancel scripts #4398

Open Devansh-46 opened 4 months ago

Devansh-46 commented 4 months ago

Pull Request Title

Description

This pull request addresses the following issues:

Changes Included

Reason for Change

The documentation was added to improve clarity for users of the auto-scaling and auto-cancel scripts. It ensures that users understand the functionality, potential issues, and how to manage their AWS resources effectively.

How to Test

  1. Review the auto-scaling-and-cancel-scripts.md file located in the docs directory.
  2. Ensure that the documentation is accurate and comprehensive.
  3. Confirm that all warnings and usage instructions are clear.

Additional Information

codecov-commenter commented 4 months ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 69.30%. Comparing base (96968d6) to head (4f33e52). Report is 1110 commits behind head on master.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #4398 +/- ## ========================================== - Coverage 72.93% 69.30% -3.63% ========================================== Files 83 20 -63 Lines 5368 3574 -1794 ========================================== - Hits 3915 2477 -1438 + Misses 1453 1097 -356 ``` [see 64 files with indirect coverage changes](https://app.codecov.io/gh/Cloud-CV/EvalAI/pull/4398/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) [see 64 files with indirect coverage changes](https://app.codecov.io/gh/Cloud-CV/EvalAI/pull/4398/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/Cloud-CV/EvalAI/pull/4398?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/Cloud-CV/EvalAI/pull/4398?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None). Last update [da7e068...4f33e52](https://app.codecov.io/gh/Cloud-CV/EvalAI/pull/4398?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=None).