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

doc: update env.py api documentation #15

Merged
merged 10 commits into from
Jun 16, 2021
Merged

doc: update env.py api documentation #15

merged 10 commits into from
Jun 16, 2021

Conversation

liuhatry
Copy link
Member

No description provided.

bagua/torch_api/env.py Outdated Show resolved Hide resolved
bagua/torch_api/env.py Outdated Show resolved Hide resolved
return int(os.environ.get("BAGUA_REPORT_METRICS", 0)) == 1


def get_autotune_level():
"""
Get the atuotune level.
Copy link
Contributor

Choose a reason for hiding this comment

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

Need to explain, or give a ref link to autotune api doc to let the readers know what this is about.

Copy link
Member

Choose a reason for hiding this comment

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

Same like above. I am going to introduce the use of autotune in the tutorial

Copy link
Member Author

Choose a reason for hiding this comment

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

this function has been hidden

bagua/torch_api/env.py Outdated Show resolved Hide resolved
@NOBLES5E NOBLES5E changed the title update env.py api doc doc: update env.py api documentation Jun 11, 2021

Returns:
The local size of the node

The local size of the node.
"""
return int(os.environ.get("LOCAL_SIZE", 1))


def get_autotune_server_addr():
Copy link
Member

Choose a reason for hiding this comment

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

Inner interface, users DO NOT need to know.

Copy link
Member Author

Choose a reason for hiding this comment

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

this function has been hidden


Returns:
The ip address of autotune server.
"""
return os.environ.get("AUTO_TUNE_SERVER_ADDR")


def is_report_metrics_switch_on():
Copy link
Member

Choose a reason for hiding this comment

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

Same like get_autotune_server_addr

Copy link
Member Author

Choose a reason for hiding this comment

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

this function has been hidden

@liuhatry liuhatry marked this pull request as draft June 16, 2021 08:49
@liuhatry liuhatry marked this pull request as ready for review June 16, 2021 09:14
@NOBLES5E NOBLES5E merged commit 5ac25ab into BaguaSys:master Jun 16, 2021
NOBLES5E pushed a commit that referenced this pull request Sep 15, 2021
Bumps [shadow-rs](https://github.com/baoyachi/shadow-rs) from 0.5.25 to 0.6.2.
- [Release notes](https://github.com/baoyachi/shadow-rs/releases)
- [Commits](baoyachi/shadow-rs@0.5.25...0.6.2)

---
updated-dependencies:
- dependency-name: shadow-rs
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
NOBLES5E pushed a commit that referenced this pull request Sep 15, 2021
Bumps [libc](https://github.com/rust-lang/libc) from 0.2.100 to 0.2.101.
- [Release notes](https://github.com/rust-lang/libc/releases)
- [Commits](rust-lang/libc@0.2.100...0.2.101)

---
updated-dependencies:
- dependency-name: libc
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
NOBLES5E pushed a commit that referenced this pull request Sep 15, 2021
NOBLES5E pushed a commit that referenced this pull request Sep 15, 2021
Bumps [shadow-rs](https://github.com/baoyachi/shadow-rs) from 0.5.25 to 0.6.2.
- [Release notes](https://github.com/baoyachi/shadow-rs/releases)
- [Commits](baoyachi/shadow-rs@0.5.25...0.6.2)

---
updated-dependencies:
- dependency-name: shadow-rs
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
NOBLES5E pushed a commit that referenced this pull request Sep 15, 2021
NOBLES5E pushed a commit that referenced this pull request Sep 15, 2021
Bumps [libc](https://github.com/rust-lang/libc) from 0.2.100 to 0.2.101.
- [Release notes](https://github.com/rust-lang/libc/releases)
- [Commits](rust-lang/libc@0.2.100...0.2.101)

---
updated-dependencies:
- dependency-name: libc
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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