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

Feat: Updates readme and a few nitpicks #223

Conversation

deependujha
Copy link
Collaborator

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?

What does this PR do?

  • Readme updated for Distributed Optimize function
    and, a few nitpicks

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

Copy link

codecov bot commented Jul 12, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Please upload report for BASE (main@df8dcd1). Learn more about missing BASE report.

Additional details and impacted files
@@          Coverage Diff          @@
##             main   #223   +/-   ##
=====================================
  Coverage        ?    77%           
=====================================
  Files           ?     33           
  Lines           ?   4695           
  Branches        ?      0           
=====================================
  Hits            ?   3621           
  Misses          ?   1074           
  Partials        ?      0           

@deependujha deependujha marked this pull request as draft July 12, 2024 04:41
@deependujha deependujha marked this pull request as ready for review July 12, 2024 08:03
Copy link

gitguardian bot commented Jul 12, 2024

⚠️ GitGuardian has uncovered 4 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
5685611 Triggered Generic High Entropy Secret 84dce3d tests/streaming/test_resolver.py View secret
5685611 Triggered Generic High Entropy Secret 84dce3d tests/streaming/test_resolver.py View secret
5685611 Triggered Generic High Entropy Secret 84dce3d tests/streaming/test_resolver.py View secret
5685611 Triggered Generic High Entropy Secret 84dce3d tests/streaming/test_resolver.py View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

@deependujha deependujha marked this pull request as draft July 12, 2024 09:14
@deependujha deependujha marked this pull request as ready for review July 12, 2024 09:54
@tchaton tchaton merged commit b234f6d into Lightning-AI:main Jul 12, 2024
27 of 28 checks passed
@deependujha deependujha deleted the feat/update-readme-for-distributed-optimize branch July 12, 2024 10:00
@@ -819,7 +820,7 @@ def test_dataset_resume_on_future_chunks(tmpdir, monkeypatch):

optimize(
fn=_simple_preprocess,
inputs=list(range(8)),
inputs=list(range(5)),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this number changed @deependujha?
This example was constructed in a specific way.

Copy link
Collaborator

@tchaton tchaton Jul 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@deependujha Unfortunately, we found another core issue and this seemed to be a legit test failure. @awaelchli is working on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants