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

Document the usage of timm as backbone provider #544

Closed
wants to merge 7 commits into from

Conversation

jpcbertoldo
Copy link
Contributor

Description

Add some text in the documentation to make it clearer that timm is used to fetch pre-trained models.

Changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which refactors the code base)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation improvement

Checklist

  • My code follows the pre-commit style and check guidelines of this project.
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • N/A

@github-actions github-actions bot added the Docs label Sep 7, 2022
@jpcbertoldo jpcbertoldo marked this pull request as ready for review September 7, 2022 13:12
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@ashwinvaidya17 ashwinvaidya17 left a comment

Choose a reason for hiding this comment

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

Thanks for updating the documentation! I have a minor comment.

docs/source/models.rst Outdated Show resolved Hide resolved
Copy link
Contributor Author

@jpcbertoldo jpcbertoldo left a comment

Choose a reason for hiding this comment

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

requested changes done

@jpcbertoldo jpcbertoldo requested review from ashwinvaidya17 and removed request for samet-akcay September 9, 2022 20:00
@ashwinvaidya17
Copy link
Collaborator

@jpcbertoldo can you have a look at the issues raised by codacy?

@jpcbertoldo
Copy link
Contributor Author

I'll try if i have time today.
Btw tests were failing in my local env.
I think it was in the other branch but it wasn't related to my changes.
I was wondering if we could arrange a call so i can get a hand with that.

@ashwinvaidya17
Copy link
Collaborator

I'll try if i have time today. Btw tests were failing in my local env. I think it was in the other branch but it wasn't related to my changes. I was wondering if we could arrange a call so i can get a hand with that.

Sure take your time. I just ran the CI and I can see that it fails for linting checks but we can have a call in case tox is not working on your machine. Maybe we might have to update the documentation. Let's continue that discussion in an email thread.

@jpcbertoldo jpcbertoldo mentioned this pull request Sep 23, 2022
12 tasks
@jpcbertoldo
Copy link
Contributor Author

this was integrated in #576

@jpcbertoldo jpcbertoldo deleted the patch-1 branch February 9, 2024 12:20
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.

Backbone/model weights source should be more obvious to figure out.
4 participants