-
Notifications
You must be signed in to change notification settings - Fork 28
/
contributing.html
197 lines (189 loc) · 12.3 KB
/
contributing.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="icon" href="img/favicon.ico">
<title>How to Contribute</title>
<!-- Bootstrap CSS -->
<link rel="stylesheet" href="css/bootstrap.css">
<link rel="stylesheet" href="vendors/linericon/style.css">
<link rel="stylesheet" href="css/font-awesome.min.css">
<link rel="stylesheet" href="vendors/owl-carousel/owl.carousel.min.css">
<link rel="stylesheet" href="vendors/lightbox/simpleLightbox.css">
<link rel="stylesheet" href="vendors/nice-select/css/nice-select.css">
<link rel="stylesheet" href="vendors/animate-css/animate.css">
<!-- main css -->
<link rel="stylesheet" href="css/style.css">
<link rel="stylesheet" href="css/responsive.css">
</head>
<body>
<!--================Header Menu Area =================-->
<header class="header_area">
<div class="main_menu">
<nav class="navbar navbar-expand-lg navbar-light">
<div class="container box_1620">
<!-- Brand and toggle get grouped for better mobile display -->
<a class="navbar-brand logo_h" href="index.html"><img src="img/speechbrain-horiz-logo.svg" width="175px" alt=""></a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse offset" id="navbarSupportedContent">
<ul class="nav navbar-nav menu_nav justify-content-center">
<li class="nav-item active"><a class="nav-link" href="index.html">Home</a></li>
<li class="nav-item"><a class="nav-link" href="about.html">About SpeechBrain</a>
<li class="nav-item"><a class="nav-link" href="contributing.html">Contributing</a>
<li class="nav-item"><a class="nav-link" href="https://speechbrain.readthedocs.io/en/latest/index.html">Documentation</a>
<li class="nav-item submenu dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Tutorials</a>
<ul class="dropdown-menu">
<li class="nav-item"><a class="nav-link" href="tutorial_basics.html">SpeechBrain Basics</a></li>
<li class="nav-item"><a class="nav-link" href="tutorial_advanced.html">SpeechBrain Advanced</a></li>
<li class="nav-item"><a class="nav-link" href="tutorial_asr.html">Speech Recognition</a></li>
<li class="nav-item"><a class="nav-link" href="tutorial_separation.html">Source Separation</a></li>
<li class="nav-item"><a class="nav-link" href="tutorial_enhancement.html">Speech Enhancement</a></li>
<li class="nav-item"><a class="nav-link" href="tutorial_classification.html">Speech Classification</a></li>
<li class="nav-item"><a class="nav-link" href="tutorial_processing.html">Speech Processing</a></li>
<li class="nav-item"><a class="nav-link" href="tutorial_nn.html">Neural Architectures</a></li>
</ul>
<li class="nav-item"><a class="nav-link" href="https://github.com/speechbrain/benchmarks">Benchmarks</a>
</li>
</ul>
</div>
</div>
</nav>
</div>
</header>
<!--================Header Menu Area =================-->
<!--================Home Banner Area =================-->
<section class="home_banner_area blog_banner">
<div class="banner_inner d-flex align-items-center">
<div class="overlay bg-parallax" data-stellar-ratio="0.9" data-stellar-vertical-offset="0" data-background=""></div>
<div class="container">
<div class="blog_b_text text-center">
<h2>Contributing</h2>
<h3>Everyone is welcome!</h3>
</div>
</div>
</div>
</section>
<!--================End Home Banner Area =================-->
<div class="alert alert-primary" role="alert" style="text-align: center; font-size: 24px;">
🎉 SpeechBrain 1.0 is out. <a href="https://colab.research.google.com/drive/1IEPfKRuvJRSjoxu22GZhb3czfVHsAy0s?usp=sharing"><strong> Check out what's new!</strong></a>
</div>
<!--================Work Area =================-->
<section class="work_area p_120">
<div class="main_title">
<h2> 🚀 Contributing to SpeechBrain</h2>
<p class="justified large"> The goal is to collectively write a set of open-source libraries for Conversational AI.
It is crucial to write a set of homogeneous libraries that are all compliant with a set of guidelines described
in our <a href="https://speechbrain.readthedocs.io/en/latest/contributing.html"> documentation </a>.
</p>
<br>
<h3> 🌟 Zen of SpeechBrain </h3>
<p class="justified large"> SpeechBrain could be used for research, academic, commercial, non-commercial purposes.If you want to contribute, keep in mind the following features:
<br/><br/>
<b>Simplicity:</b> the code must be easy to understand even by students or users that are not professional programmers or speech researchers.
Design your code such that it can be easily read. Given alternatives with the same level of performance, code the simplest one. <br/><br/>
<b>Modularity:</b> Write your code to be modular and well-fitting with the other functionalities of the toolkit. The idea is to develop a bunch of models that can be naturally interconnected with each other. <br/><br/>
<b>Efficiency:</b> The code should be as efficient as possible. Contributors should maximize the use of pytorch native operations
<br/><br/>
<b>Documentation:</b> Given the goals of SpeechBrain, writing rich and good documentation is a crucial step. Write docstrings with runnable examples (as done in PyTorch code).
<br/><br/>
<h3> 🔧 How to get my code into SpeechBrain? </h3>
<p class="justified large"> SpeechBrain is hosted via <a href="https://github.com/speechbrain/speechbrain"> GitHub </a>. Contributing requires three steps: <br/><br/>
<b>1.</b> Fork, clone the <a href="https://github.com/speechbrain/speechbrain">repository</a> and install our test suite as detailed in <a href="https://speechbrain.readthedocs.io/en/latest/contributing.html"> the documentation </a>. <br/>
<b>2.</b> Write your code and test it properly. Commit your changes to your fork with our pre-commit tests to ensure tests are passing.
Then open a pull request on the official repository.<br/>
<b>3.</b> Participate in the review process. Each pull request is reviewed by one or two reviewers.
Please integrate their feedback into your code. Once reviewers are happy with your pull request, they will merge it into the official code. <br/><br/>
<b>Details about this process (i.e including steps for installing the tests) are given in <a href="https://speechbrain.readthedocs.io/en/latest/contributing.html"> the documentation </a>.</b>
</p>
<br/><br/>
<h3> 🙌 How can I help? </h3>
<p class="justified large"> Examples of contributions include new recipes, new models, new external functionalities, solving issues/bugs.
</p>
</div>
<div class="main_title">
<h2>🌟 Contributors</h2>
<p class="justified large">We would like to thank the following contributors:</p>
</div>
<ul class="contributors-list">
<li>Mirco Ravanelli, Concordia University, Mila (CA)</li>
<li>Titouan Parcollet, Samsung, Cambridge University (UK)</li>
<li>Peter Plantinga, Ohio State University (USA)</li>
<li>Aku Rouhe, Aalto University (FI)</li>
<li>Adel Moumen, Avignon Université (LIA, FR) </li>
<li>Sylvain de Langen, Avignon Université (LIA, FR) </li>
<li>Cem Subakan, Mila, Laval University (CA)</li>
<li>Luca Della Libera, Concordia University, Mila (CA)</li>
<li>Pooneh Mousavi, Concordia University, Mila (CA)</li>
<li>Artem Ploujnikov, Université de Montréal, Mila (CA)</li>
<li>Davide Borra, University of Bologna (IT)</li>
<li>Francesco Paissan, Fondazione Bruno Kessler (IT)</li>
<li>Mahed Mousavi, University of Trento (IT)</li>
<li>Salah Zaiem, Telecom Paris (FR)</li>
<li>Zeyu Zhao, University of Edinburgh (UK)</li>
<li> Pierre Champion, INRIA (FR)</li>
<li> Georgios Karakasidis, University of Edinburgh (UK)</li>
<li> Sung-Lin Yeh, University of Edinburgh (UK)</li>
<li> Yingzhi Wang, Zaion (FR)</li>
<li> Dongwon Kim, Krafton AI (KR)</li>
<li> Xuechen Liu, Aalto University (FI)</li>
<li> Andreas Nautsch, Avignon Université (LIA, FR)</li>
<li> Pradnya Kandarkar, Concordia University</li>
<li> Jarod Duret, Avignon Université (LIA, FR)</li>
<li> Sangeet Sagar, Saarland University (GE) </li>
<li> Gaëlle Laperrière, Avignon Université (LIA, FR) </li>
<li> Pablo Zuluaga, École Polytechnique Fédérale de Lausanne (EPFL, CH)</li>
<li> Florian Mai, École Polytechnique Fédérale de Lausanne (EPFL, CH)</li>
<li> Loren Lugosch, Mila, McGill University (CA)</li>
<li> Nauman Dawalatabad, Indian Institute of Technology Madras (IN)</li>
<li> Ju-Chieh Chou, National Taiwan University (TW)</li>
<li> Abdel Heba, Linagora / University of Toulouse (IRIT, FR)</li>
<li> Francois Grondin, University of Sherbrooke (CA)</li>
<li> William Aris, University of Sherbrooke (CA)</li>
<li> Chien-Feng Liao, National Taiwan University (TW)</li>
<li> Samuele Cornell, Università Politecnica delle Marche (IT)</li>
<li> Sung-Lin Yeh, National Tsing Hua University (TW)</li>
<li> Hwidong Na, Visiting Researcher Samsung SAIL (CA)</li>
<li> Yan Gao, University of Cambridge (UK)</li>
<li> Szu-Wei Fu, Academia Sinica (TW)</li>
<li> Elena Rastorgueva, University of Cambridge (UK)</li>
<li> Jianyuan Zhong, University of Rochester (USA)<li>
<li> Brecht Desplanques, Ghent University (BE)<li>
<li> Jenthe Thienpondt, Ghent University (BE)<li>
<li> Salima Mdhaffar, Avignon Université (LIA, FR)<li>
<li> Mickael Rouvier, Avignon University (LIA, FR)</li>
<li> Yannick Estève, Avignon University (LIA, FR)</li>
<li> Renato De Mori, McGill University (CA), Avignon University (LIA, FR)</li>
<li> Yoshua Bengio, Mila, University of Montréal (CA)</li>
</ul>
</div>
</section>
<!--================End Work Area =================-->
<!-- Optional JavaScript -->
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="js/jquery-3.2.1.min.js"></script>
<script src="js/popper.js"></script>
<script src="js/bootstrap.min.js"></script>
<script src="js/stellar.js"></script>
<script src="vendors/lightbox/simpleLightbox.min.js"></script>
<script src="vendors/nice-select/js/jquery.nice-select.min.js"></script>
<script src="vendors/isotope/imagesloaded.pkgd.min.js"></script>
<script src="vendors/isotope/isotope-min.js"></script>
<script src="vendors/owl-carousel/owl.carousel.min.js"></script>
<script src="js/jquery.ajaxchimp.min.js"></script>
<script src="js/mail-script.js"></script>
<script src="vendors/counter-up/jquery.waypoints.min.js"></script>
<script src="vendors/counter-up/jquery.counterup.min.js"></script>
<script src="js/theme.js"></script>
<link rel="stylesheet" href="js/styles/monokai-sublime.css">
<script src="js/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>