Skip to content

Commit 0ada5fc

Browse files
authored
Readme: added the contribute section
1 parent aea1166 commit 0ada5fc

1 file changed

Lines changed: 20 additions & 2 deletions

File tree

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ TensorFlow.NET is a member project of [SciSharp STACK](https://github.com/SciSha
1212

1313
![tensors_flowing](docs/assets/tensors_flowing.gif)
1414

15-
### Why should you use TensorFlow.NET ?
15+
### Why TensorFlow.NET ?
1616

1717
`SciSharp STASK`'s mission is to bring popular data science technology into the .NET world and to provide .NET developers with a powerful Machine Learning tool set without reinventing the wheel. Scince the APIs are kept as similar as possible you can immediately adapt any existing Tensorflow code in C# with a zero learning curve. Take a look at a comparison picture and see how comfortably a Tensorflow/Python script translates into a C# program with TensorFlow.NET.
1818

@@ -82,10 +82,28 @@ Read the docs & book [The Definitive Guide to Tensorflow.NET](https://tensorflow
8282
* [Naive Bayes Classification](test/TensorFlowNET.Examples/NaiveBayesClassifier.cs)
8383
* [Named Entity Recognition](test/TensorFlowNET.Examples/NamedEntityRecognition.cs)
8484

85+
### Contribute:
86+
87+
Feel like contributing to one of the hottest projects in the Machine Learning field? Want to know how Tensorflow magically creates the computational graph? We appreciate every contribution however small. There are tasks for novices to experts alike, if everyone tackles only a small task the sum of contributions will be huge.
88+
89+
You can:
90+
* Let everyone know about this project (trivial)
91+
* Port Tensorflow unit tests from Python to C# (easy)
92+
* Port missing Tensorflow code from Python to C# (easy)
93+
* Port Tensorflow examples to C# and raise issues if you come accross missing parts of the API (easy)
94+
* Debug one of the unit tests that is marked as Ignored to get it to work (can be challenging)
95+
* Debug one of the not yet working examples and get it to work (hard)
96+
97+
How to debug unit tests:
98+
99+
The best way to find out why a unit test is failing is to single step it in C# and its pendant Python at the same time to see where the flow of execution digresses or where variables exhibit different values. Good Python IDEs like PyCharm let you single step into the tensorflow library code.
100+
101+
### Contact
102+
85103
Feel free to star or raise issue on [Github](https://github.com/SciSharp/TensorFlow.NET).
86104

105+
Join our Chat on [Gitter](https://gitter.im/sci-sharp/community)
87106
Scan QR code to join Tencent TIM group:
88107

89108
![SciSharp STACK](docs/TIM.jpg)
90109

91-
Or join our Chat on [Gitter](https://gitter.im/sci-sharp/community)

0 commit comments

Comments
 (0)