Skip to content

Commit

Permalink
Add 'contrib' directory (facebookresearch#1333)
Browse files Browse the repository at this point in the history
Summary:
## Motivation and Context

We need the 'contrib' directory to hold experimental code, which is accessible in OSS. First 2 use cases: 1) moving HuggingFace transform related code and dependency there 2) maintain prototypes for PyText Library there

## How Has This Been Tested

## 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)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist

- [ ] 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.
- [ ] I have read the **CONTRIBUTING** document.
- [x] I have completed my CLA (see **CONTRIBUTING**)
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
Pull Request resolved: facebookresearch#1333

Differential Revision: D21189667

Pulled By: hudeven

fbshipit-source-id: 55b3a2488a3e3bae49b6834f9f442c4c59a2e8a1
  • Loading branch information
hudeven authored and facebook-github-bot committed Apr 23, 2020
1 parent 9445982 commit 4a3cae0
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions pytext/contrib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# What is 'contrib' directory?

Code in 'contrib' directory is considered experimental. If it's proved to be useful, we may incorporate it into the core PyText structure. The code review turnaround time for changes in 'contrib' is expected to be shorter than changes in the core PyText structure.

'contrib' is organized by projects. We recommend the following directory structure to prevent file collisions:

```
contrib/
my_project/ - project name
common/ - mimic the core PyText structure
config/
data/
...
```

0 comments on commit 4a3cae0

Please sign in to comment.