r/java • • Jun 29 '17

Basic neural network Java implementation, which can train itself, for beginners to try out and learn how machine learning works.

https://github.com/sebig3000/MachineLearning
264 Upvotes

28 comments sorted by

View all comments

29

u/ron_krugman Jun 30 '17

A few remarks on style:

  • Always put a block with curly braces after if, while, etc. even if there is just a single statement within and braces are technically optional.

  • Prefer enums over int constants. They are strongly typed in Java, which makes it much harder to accidentally pass an invalid value.

  • Throw a java.lang.IllegalArgumentException in case of an invalid input. It is more concise and saves you the trouble of checked exceptions.

  • Also, you probably shouldn't ever instantiate a java.lang.Exception directly. Throw a java.lang.RuntimeException if you're not sure about what type of exception to throw.

7

u/[deleted] Jun 30 '17

Can you provide some justification for that last bullet point? I've been writing Java for a while now and have never heard that.

8

u/locatedtaco Jun 30 '17

I could be wrong but I think the point is that throwing an Exception isn't expressive. It doesn't clue in the developer about what went wrong. Also, if you throw an Exception the client code can't selectively catch it and handle it specifically.

6

u/[deleted] Jun 30 '17

Ah, I thought you meant all checked exceptions, not just the Exception class...it's perfectly ok to instantiate specific subclasses of Exception

5

u/locatedtaco Jun 30 '17

Yeah, exactly. But, that's just how I interpreted the comment. I didn't write it.

4

u/ron_krugman Jun 30 '17

That's exactly what I meant, thanks! Of course it's fine to instantiate and throw for example java.io.IOException etc. although personally I would very much prefer a java.io.UncheckedIOException.

I'm not going to lie: I really fucking hate checked exceptions. They're one of the worst parts of Java.

2

u/sebig3000 Jun 30 '17

Thank for the tips! I'm still a student and started to learn how to code Java one year ago so I'm still a newbie. But I will apply your advice!

6

u/ron_krugman Jun 30 '17

Don't worry about it, my first personal Java projects (>10 years ago) didn't look better either. Learning to code is a marathon, not a sprint. As long as you don't give up and keep improving just a little bit, you'll get there.

3

u/[deleted] Jun 30 '17

You can also make identifier names more meaningful so you don't need as many comments. For example, numberOfInputs instead of input_n.