Start-neural-networks-forwardpropagation

[sam-the-programmer]

What I have changed 📝

I have added basic tests for forwardprop of the easyneuon.neuron API.

Possible issues ⛔

No backprop yet.

Additional notes ⭐

None

[sourcery-ai]

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 0.43%.

Quality metrics	Before	After	Change
Complexity	1.87 ⭐	1.82 ⭐	-0.05 👍
Method Length	29.30 ⭐	30.13 ⭐	0.83 👎
Working memory	6.94 🙂	7.28 🙂	0.34 👎
Quality	80.51% ⭐	80.08% ⭐	-0.43% 👎

Other metrics	Before	After	Change
Lines	1353	1500	147

Changed files	Quality Before	Quality After	Quality Change
setup.py	69.72% 🙂	72.06% 🙂	2.34% 👍
admin/scripts/clear_logs.py	83.71% ⭐	83.71% ⭐	0.00%
admin/scripts/coverage.py	69.60% 🙂	69.60% 🙂	0.00%
admin/scripts/new_here.py	95.36% ⭐	95.36% ⭐	0.00%
admin/scripts/update_todo.py	69.81% 🙂	69.81% 🙂	0.00%
easyneuron/init.py	%	%	%
easyneuron/_classes/init.py	%	%	%
easyneuron/_classes/models.py	94.38% ⭐	94.38% ⭐	0.00%
easyneuron/_testutils/init.py	%	%	%
easyneuron/_testutils/gh_actions.py	99.17% ⭐	99.17% ⭐	0.00%
easyneuron/_testutils/logger.py	58.21% 🙂	69.14% 🙂	10.93% 👍
easyneuron/agents/init.py	%	%	%
easyneuron/agents/envs/init.py	%	%	%
easyneuron/agents/envs/_classes.py	97.09% ⭐	97.09% ⭐	0.00%
easyneuron/agents/envs/examples.py	95.49% ⭐	95.46% ⭐	-0.03% 👎
easyneuron/data/init.py	%	%	%
easyneuron/data/gen.py	75.96% ⭐	75.96% ⭐	0.00%
easyneuron/data/load.py	93.30% ⭐	93.30% ⭐	0.00%
easyneuron/exceptions/init.py	%	%	%
easyneuron/exceptions/exceptions.py	99.83% ⭐	99.83% ⭐	0.00%
easyneuron/genetic/init.py	%	%	%
easyneuron/genetic/genomes/init.py	%	%	%
easyneuron/genetic/optimisers/optimisers.py	64.78% 🙂	64.78% 🙂	0.00%
easyneuron/logging/init.py	%	%	%
easyneuron/logging/logging.py	90.72% ⭐	90.72% ⭐	0.00%
easyneuron/math/init.py	%	%	%
easyneuron/math/distance/init.py	%	%	%
easyneuron/math/distance/distance.py	78.07% ⭐	78.07% ⭐	0.00%
easyneuron/math/random/init.py	%	%	%
easyneuron/math/random/random.py	97.42% ⭐	97.42% ⭐	0.00%
easyneuron/metrics/init.py	%	%	%
easyneuron/metrics/accuracy/init.py	%	%	%
easyneuron/metrics/accuracy/accuracy.py	85.05% ⭐	85.05% ⭐	0.00%
easyneuron/metrics/loss/init.py	86.03% ⭐	86.03% ⭐	0.00%
easyneuron/metrics/loss/meanerrors.py	83.41% ⭐	83.41% ⭐	0.00%
easyneuron/neighbours/init.py	%	%	%
easyneuron/neighbours/_classes.py	94.51% ⭐	94.51% ⭐	0.00%
easyneuron/neighbours/knearest.py	69.52% 🙂	69.52% 🙂	0.00%
easyneuron/types/init.py	%	%	%
easyneuron/types/types.py	57.16% 🙂	50.07% 🙂	-7.09% 👎
examples/kNN.py	81.83% ⭐	67.53% 🙂	-14.30% 👎
tests/test_agents_envs.py	94.23% ⭐	94.23% ⭐	0.00%
tests/test_data.py	91.02% ⭐	91.02% ⭐	0.00%
tests/test_genetic.py	80.08% ⭐	80.08% ⭐	0.00%
tests/test_logging.py	88.82% ⭐	85.34% ⭐	-3.48% 👎
tests/test_maths.py	91.37% ⭐	91.37% ⭐	0.00%
tests/test_metrics.py	88.87% ⭐	88.87% ⭐	0.00%
tests/test_neighbours.py	87.63% ⭐	87.60% ⭐	-0.03% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
easyneuron/genetic/optimisers/optimisers.py	BasicOptimiser.optimise	8 ⭐	140 😞	14 😞	49.55% 😞	Try splitting into smaller methods. Extract out complex expressions
easyneuron/neighbours/knearest.py	KNNClassifier._choose_label	10 🙂	121 😞	10 😞	56.55% 🙂	Try splitting into smaller methods. Extract out complex expressions
easyneuron/_testutils/logger.py	log_errors	6 ⭐	97 🙂	14 😞	56.87% 🙂	Extract out complex expressions
easyneuron/_testutils/logger.py	log_errors.wrapper	4 ⭐	92 🙂	14 😞	59.52% 🙂	Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[sam-the-programmer]

Starting pull request

[sam-the-programmer]

Reopening