CONTRIBUTING.md

Want to contribute to doddle-model but not sure where to start?

You've come to the right place :). There are many ways to contribute and writing code is only one of them. It's important to note that all kinds of contributions are equally appreciated. Below we name just a few, if you have some other idea, don't hesitate to get in touch.

Use doddle-model in your own work

Seriously, just by using the project your are helping a ton! If you encounter any problems, you can talk to us on gitter or open a new issue here.

Write a blog post

This is a big one. If you used doddle-model to develop a cool model, writing about it helps us enormously with the exposure. Here's one example published on Medium.

Write / improve the documentation

There's never enough of documentation and we know that! If you think we are lacking in that regard (and we are) feel free to open a PR that adds or improves the documentation.

Write examples / tutorials

We have a repository full of examples on how to use doddle-model. And with examples... well it's similar as with documentation: we need moar! Some other ideas / projects are available below:

• SMS spam classification
• serving a model in an Apache Beam pipeline
• serving system for pre-trained models
• benchmarking performance of implementations

Help shape the roadmap

Be sure to take a look at the roadmap to get a better understanding about the direction in which we are heading. Your input on that is also welcome.

Write some code

Finally, if you want to dive deep into the source code and write some new features or fix a simple bug (like that's a thing) there are some points that you should read first:

• for a list of typeclasses that together define the estimator API see the typeclasses directory
• concerning the code style, PayPal Scala Style and Databricks Scala Guide are roughly followed (note that a maximum line length of 120 characters is used)
• be sure to also check the roadmap and the kanban board