Skip to content
This repository has been archived by the owner on Dec 18, 2023. It is now read-only.

Update static docs to describe NNC #1619

Closed

Conversation

feynmanliang
Copy link
Contributor

Motivation

NNC is no longer in experimental. Lets update docs to encourage usage.

Changes proposed

Defaults NNC to true, updates static docs to feature NNC prominently.

Test Plan

GH docs build

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • The title of my pull request is a short description of the requested changes.

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Aug 23, 2022
@facebook-github-bot
Copy link
Collaborator

@feynmanliang has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

feynmanliang added a commit to feynmanliang/beanmachine that referenced this pull request Aug 25, 2022
…search#1619)

Summary:
### Motivation

NNC is no longer in experimental. Lets update docs to encourage usage.

### Changes proposed

Defaults NNC to true, updates static docs to feature NNC prominently.

Pull Request resolved: facebookresearch#1619

Test Plan:
GH docs build

### Types of changes
- [x] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Breaking change (fix or feature that would cause existing functionality to change)

### Checklist
- [x] My code follows the code style of this project.
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I have read the **[CONTRIBUTING](https://github.com/facebookresearch/beanmachine/blob/main/CONTRIBUTING.md)** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [x] The title of my pull request is a short description of the requested changes.

Differential Revision: D38956485

Pulled By: feynmanliang

fbshipit-source-id: bba8eaabfdec8036638fafeaaa3874b7b4e8fc90
@facebook-github-bot
Copy link
Collaborator

This pull request was exported from Phabricator. Differential Revision: D38956485

feynmanliang added a commit to feynmanliang/beanmachine that referenced this pull request Aug 26, 2022
…search#1619)

Summary:
### Motivation

NNC is no longer in experimental. Lets update docs to encourage usage.

### Changes proposed

Defaults NNC to true, updates static docs to feature NNC prominently.

Pull Request resolved: facebookresearch#1619

Test Plan:
GH docs build

### Types of changes
- [x] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Breaking change (fix or feature that would cause existing functionality to change)

### Checklist
- [x] My code follows the code style of this project.
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I have read the **[CONTRIBUTING](https://github.com/facebookresearch/beanmachine/blob/main/CONTRIBUTING.md)** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [x] The title of my pull request is a short description of the requested changes.

Differential Revision: D38956485

Pulled By: feynmanliang

fbshipit-source-id: 4486915765f868bb9de05eef6f90bf4b1bdff144
@facebook-github-bot
Copy link
Collaborator

This pull request was exported from Phabricator. Differential Revision: D38956485

…search#1619)

Summary:
### Motivation

NNC is no longer in experimental. Lets update docs to encourage usage.

### Changes proposed

Defaults NNC to true, updates static docs to feature NNC prominently.

Pull Request resolved: facebookresearch#1619

Test Plan:
GH docs build

### Types of changes
- [x] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Breaking change (fix or feature that would cause existing functionality to change)

### Checklist
- [x] My code follows the code style of this project.
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [x] I have read the **[CONTRIBUTING](https://github.com/facebookresearch/beanmachine/blob/main/CONTRIBUTING.md)** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [x] The title of my pull request is a short description of the requested changes.

Differential Revision: D38956485

Pulled By: feynmanliang

fbshipit-source-id: 1fca7a8e2ad36a62b19770cc9d446a5f842dec85
@facebook-github-bot
Copy link
Collaborator

This pull request was exported from Phabricator. Differential Revision: D38956485

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants