B
B
BadThings2019-09-13 02:18:46
IT education
BadThings, 2019-09-13 02:18:46

How to write a pre-jun training project report?

Actually, after a summer practice (university), I continued to do a project on neurons. Now it is finished and, accordingly, it is necessary to provide a small report. Not standard in practice (it is done, but according to the classics there is a lot of water and only 1/3 of the work done is described), but with the content of the code.
The project is very piecemeal and split into several jupyter-notebooks. Half of the code is repeated, another third with minimal changes, the remaining 20-30% is different in almost all laptops, but they are essentially the main ones - training and everything related
. If I leave only the "main" part, it will turn out around 50 lines, which I think quite controversially, it will be possible to call a report for more than 1 month of work
A, well, shit code, yes. Fierce. For python was not the main language and there was only 1 small project on it
Also, there was an idea to take only the last two laptops, already less govnokodnye and already written with a greater understanding of what is happening. Although it's still quite a bit of code. However, the question still remains in what form should these laptops be presented as a report? Make it readable (as here https://habr.com/en/post/87530/), comments in the code, add descriptions for sentences or two before meaningful pieces?
Although knowing your love for worrying over trifles, maybe it’s not worth it to worry so much and write a small report?

Answer the question

In order to leave comments, you need to log in

1 answer(s)
R
Robur, 2019-09-13
@Robur

Who needs the report?
If the formal one with water has already been done - write a normal, specific one, what was done, why and what results were obtained. The more specific the better. If there are 50 lines left, but for each you will answer and it will be clear what is behind this code - that's great. The visibility of "more work" and letting in the importance - you have already done this in the first report.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question