Skip to content

Commit 4a3cae0

Browse files
hudevenfacebook-github-bot
authored andcommitted
Add 'contrib' directory (facebookresearch#1333)
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
1 parent 9445982 commit 4a3cae0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

pytext/contrib/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# What is 'contrib' directory?
2+
3+
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.
4+
5+
'contrib' is organized by projects. We recommend the following directory structure to prevent file collisions:
6+
7+
```
8+
contrib/
9+
my_project/ - project name
10+
common/ - mimic the core PyText structure
11+
config/
12+
data/
13+
...
14+
```

0 commit comments

Comments
 (0)