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.

Sign up for GitHub

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

Jump to bottom

feat: add conf_path in PetrelBackend #2459

Merged
merged 3 commits into from
Nov 28, 2022
Merged

feat: add conf_path in PetrelBackend #2459

merged 3 commits into from
Nov 28, 2022

Conversation

sunyc11
Copy link

@sunyc11 sunyc11 commented Nov 25, 2022 •
edited
Loading

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Add conf_path in PetrelBackend initial parameters to set user-defined petrel client config path.

Modification

Add conf_path in PetrelBackend initial parameters to set user-defined petrel client config path.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

Before PR:

  • I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
  • Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
  • Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
  • New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects, like MMDet or MMCls.
  • CLA has been signed and all committers have signed the CLA in this PR.

@CLAassistant
Copy link

CLAassistant commented Nov 25, 2022 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

zhouzaida
zhouzaida reviewed Nov 28, 2022
View reviewed changes
mmcv/fileio/file_client.py Outdated
@@ -108,14 +109,15 @@ class PetrelBackend(BaseStorageBackend):

def __init__(self,
path_mapping: Optional[dict] = None,
conf_path: str = None,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Adding a new parameter in the middle position may cause a bc issue. Suggest moving it to the end.

zhouzaida
zhouzaida reviewed Nov 28, 2022
View reviewed changes
mmcv/fileio/file_client.py Outdated
@@ -95,6 +95,7 @@ class PetrelBackend(BaseStorageBackend):
path_mapping (dict, optional): Path mapping dict from local path to
Petrel path. When ``path_mapping={'src': 'dst'}``, ``src`` in
``filepath`` will be replaced by ``dst``. Default: None.
conf_path (str, optional): Petrel client config path. Default: None.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
conf_path (str, optional): Petrel client config path. Default: None.
conf_path (str, optional): Config path of Petrel client. Default: None.
`New in version 1.7.1`.

Copy link
Collaborator

Choose a reason for hiding this comment

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

move this line to the end.

@zhouzaida
Copy link
Collaborator

CLA assistant check Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

sunyecheng seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Hi, thanks for your contribution. Please sign the CLA before we merge this PR.

@sunyc11
Copy link
Author

sunyc11 commented Nov 28, 2022

hi, @zhouzaida , I've signed the CLA and adjusted the order of parameters.

@zhouzaida zhouzaida merged commit c1712ee into open-mmlab:master Nov 28, 2022
ckirchhoff2021 pushed a commit to ckirchhoff2021/mmcv that referenced this pull request Dec 21, 2022
@sunyc11 @ckirchhoff2021
[Enhance] Add conf_path in PetrelBackend (open-mmlab#2459)
82c9e19 
* feat: add conf_path in PetrelBackend

* fix: add conf_path in MockPetrelClient

* fix: adjust parameters order
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zhouzaida zhouzaida zhouzaida approved these changes

Assignees

@ice-tong ice-tong

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sunyc11 @CLAassistant @zhouzaida @ice-tong