SupportVectorMachine::__construct() - Code Metrics - Inspection of "Validation and Exception in new methods: setBinPat..." - php-ai/php-ml - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#88)

unknown

created 2017-05-14 04:52 UTC

SupportVectorMachine::__construct() A

↳ Parent: SupportVectorMachine

Complexity

Conditions	1
Paths	1

Size

Total Lines	23
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	23
rs	9.0856
c	0
b	0
f	0
cc	1
eloc	19
nc	1
nop	12

How to fix Many Parameters

<?php

declare(strict_types=1);

namespace Phpml\SupportVectorMachine;

use Phpml\Helper\Trainable;
use Phpml\Exception\SupportVectorMachineException;

class SupportVectorMachine
{
    use Trainable;

    /**
     * @var int
     */
    private $type;

    /**
     * @var int
     */
    private $kernel;

    /**
     * @var float
     */
    private $cost;

    /**
     * @var float
     */
    private $nu;

    /**
     * @var int
     */
    private $degree;

    /**
     * @var float
     */
    private $gamma;

    /**
     * @var float
     */
    private $coef0;

    /**
     * @var float
     */
    private $epsilon;

    /**
     * @var float
     */
    private $tolerance;

    /**
     * @var int
     */
    private $cacheSize;

    /**
     * @var bool
     */
    private $shrinking;

    /**
     * @var bool
     */
    private $probabilityEstimates;

    /**
     * @var string
     */
    private $binPath;

    /**
     * @var string
     */
    private $varPath;

    /**
     * @var string
     */
    private $model;

    /**
     * @var array
     */
    private $targets = [];

    /**
     * @param int        $type
     * @param int        $kernel
     * @param float      $cost
     * @param float      $nu
     * @param int        $degree
     * @param float|null $gamma
     * @param float      $coef0
     * @param float      $epsilon
     * @param float      $tolerance
     * @param int        $cacheSize
     * @param bool       $shrinking
     * @param bool       $probabilityEstimates
     */
    public function __construct(
        int $type, int $kernel, float $cost = 1.0, float $nu = 0.5, int $degree = 3,
        float $gamma = null, float $coef0 = 0.0, float $epsilon = 0.1, float $tolerance = 0.001,
        int $cacheSize = 100, bool $shrinking = true, bool $probabilityEstimates = false
    ) {
        $this->type = $type;
        $this->kernel = $kernel;
        $this->cost = $cost;
        $this->nu = $nu;
        $this->degree = $degree;
        $this->gamma = $gamma;
        $this->coef0 = $coef0;
        $this->epsilon = $epsilon;
        $this->tolerance = $tolerance;
        $this->cacheSize = $cacheSize;
        $this->shrinking = $shrinking;
        $this->probabilityEstimates = $probabilityEstimates;

        $rootPath = realpath(implode(DIRECTORY_SEPARATOR, [__DIR__, '..', '..', '..'])).DIRECTORY_SEPARATOR;

        $this->binPath = $rootPath.'bin'.DIRECTORY_SEPARATOR.'libsvm'.DIRECTORY_SEPARATOR;
        $this->varPath = $rootPath.'var'.DIRECTORY_SEPARATOR;
    }

    /**
     * @param string $binPath
     * 
     * @throws SupportVectorMachineException
     */
    public function setBinPath(string $binPath)
    {
        if (!is_dir($binPath)) {
            throw SupportVectorMachineException::missingBinPath($binPath);
        }

        $binPath = realpath($binPath).DIRECTORY_SEPARATOR;

        $trainFile = sprintf('%ssvm-train%s', $binPath, $this->getOSExtension());
        $predictFile = sprintf('%ssvm-predict%s', $binPath, $this->getOSExtension());

        if (!is_executable($trainFile)) {
            throw SupportVectorMachineException::missingTrainFile($trainFile);
        }

        if (!is_executable($predictFile)) {
            throw SupportVectorMachineException::missingPredictFile($predictFile);
        }

        $this->binPath = $binPath;

        return $this;
    }

    /**
     * @param string $varPath
     * 
     * @throws SupportVectorMachineException
     */
    public function setVarPath(string $varPath)
    {
        if (!is_dir($varPath)) {
            throw SupportVectorMachineException::missingVarPath($varPath);
        }

        $varPath = realpath($varPath).DIRECTORY_SEPARATOR;

        $this->varPath = $varPath;

        return $this;
    }

    /**
     * @param array $samples
     * @param array $targets
     */
    public function train(array $samples, array $targets)
    {
        $this->samples = array_merge($this->samples, $samples);
        $this->targets = array_merge($this->targets, $targets);

        $trainingSet = DataTransformer::trainingSet($this->samples, $this->targets, in_array($this->type, [Type::EPSILON_SVR, Type::NU_SVR]));
        file_put_contents($trainingSetFileName = $this->varPath.uniqid('phpml', true), $trainingSet);
        $modelFileName = $trainingSetFileName.'-model';

        $command = $this->buildTrainCommand($trainingSetFileName, $modelFileName);
        $output = '';
        exec(escapeshellcmd($command), $output);

        $this->model = file_get_contents($modelFileName);

        unlink($trainingSetFileName);
        unlink($modelFileName);
    }

    /**
     * @return string
     */
    public function getModel()
    {
        return $this->model;
    }

    /**
     * @param array $samples
     *
     * @return array
     */
    public function predict(array $samples)
    {
        $testSet = DataTransformer::testSet($samples);
        file_put_contents($testSetFileName = $this->varPath.uniqid('phpml', true), $testSet);
        file_put_contents($modelFileName = $testSetFileName.'-model', $this->model);
        $outputFileName = $testSetFileName.'-output';

        $command = sprintf('%ssvm-predict%s %s %s %s', $this->binPath, $this->getOSExtension(), $testSetFileName, $modelFileName, $outputFileName);
        $output = '';
        exec(escapeshellcmd($command), $output);

        $predictions = file_get_contents($outputFileName);

        unlink($testSetFileName);
        unlink($modelFileName);
        unlink($outputFileName);

        if (in_array($this->type, [Type::C_SVC, Type::NU_SVC])) {
            $predictions = DataTransformer::predictions($predictions, $this->targets);
        } else {
            $predictions = explode(PHP_EOL, trim($predictions));
        }

        if (!is_array($samples[0])) {
            return $predictions[0];
        }

        return $predictions;
    }

    /**
     * @return string
     */
    private function getOSExtension()
    {
        $os = strtoupper(substr(PHP_OS, 0, 3));
        if ($os === 'WIN') {
            return '.exe';
        } elseif ($os === 'DAR') {
            return '-osx';
        }

        return '';
    }

    /**
     * @param $trainingSetFileName
     * @param $modelFileName
     *
     * @return string
     */
    private function buildTrainCommand(string $trainingSetFileName, string $modelFileName): string
    {
        return sprintf('%ssvm-train%s -s %s -t %s -c %s -n %s -d %s%s -r %s -p %s -m %s -e %s -h %d -b %d %s %s',
            $this->binPath,
            $this->getOSExtension(),
            $this->type,
            $this->kernel,
            $this->cost,
            $this->nu,
            $this->degree,
            $this->gamma !== null ? ' -g '.$this->gamma : '',
            $this->coef0,
            $this->epsilon,
            $this->cacheSize,
            $this->tolerance,
            $this->shrinking,
            $this->probabilityEstimates,
            escapeshellarg($trainingSetFileName),
            escapeshellarg($modelFileName)
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Phpml\SupportVectorMachine;
6
7			use Phpml\Helper\Trainable;
8			use Phpml\Exception\SupportVectorMachineException;
9
10			class SupportVectorMachine
11			{
12			use Trainable;
13
14			/**
15			* @var int
16			*/
17			private $type;
18
19			/**
20			* @var int
21			*/
22			private $kernel;
23
24			/**
25			* @var float
26			*/
27			private $cost;
28
29			/**
30			* @var float
31			*/
32			private $nu;
33
34			/**
35			* @var int
36			*/
37			private $degree;
38
39			/**
40			* @var float
41			*/
42			private $gamma;
43
44			/**
45			* @var float
46			*/
47			private $coef0;
48
49			/**
50			* @var float
51			*/
52			private $epsilon;
53
54			/**
55			* @var float
56			*/
57			private $tolerance;
58
59			/**
60			* @var int
61			*/
62			private $cacheSize;
63
64			/**
65			* @var bool
66			*/
67			private $shrinking;
68
69			/**
70			* @var bool
71			*/
72			private $probabilityEstimates;
73
74			/**
75			* @var string
76			*/
77			private $binPath;
78
79			/**
80			* @var string
81			*/
82			private $varPath;
83
84			/**
85			* @var string
86			*/
87			private $model;
88
89			/**
90			* @var array
91			*/
92			private $targets = [];
93
94			/**
95			* @param int $type
96			* @param int $kernel
97			* @param float $cost
98			* @param float $nu
99			* @param int $degree
100			* @param float\|null $gamma
101			* @param float $coef0
102			* @param float $epsilon
103			* @param float $tolerance
104			* @param int $cacheSize
105			* @param bool $shrinking
106			* @param bool $probabilityEstimates
107			*/
108			public function __construct(
109			int $type, int $kernel, float $cost = 1.0, float $nu = 0.5, int $degree = 3,
110			float $gamma = null, float $coef0 = 0.0, float $epsilon = 0.1, float $tolerance = 0.001,
111			int $cacheSize = 100, bool $shrinking = true, bool $probabilityEstimates = false
112			) {
113			$this->type = $type;
114			$this->kernel = $kernel;
115			$this->cost = $cost;
116			$this->nu = $nu;
117			$this->degree = $degree;
118			$this->gamma = $gamma;
119			$this->coef0 = $coef0;
120			$this->epsilon = $epsilon;
121			$this->tolerance = $tolerance;
122			$this->cacheSize = $cacheSize;
123			$this->shrinking = $shrinking;
124			$this->probabilityEstimates = $probabilityEstimates;
125
126			$rootPath = realpath(implode(DIRECTORY_SEPARATOR, [__DIR__, '..', '..', '..'])).DIRECTORY_SEPARATOR;
127
128			$this->binPath = $rootPath.'bin'.DIRECTORY_SEPARATOR.'libsvm'.DIRECTORY_SEPARATOR;
129			$this->varPath = $rootPath.'var'.DIRECTORY_SEPARATOR;
130			}
131
132			/**
133			* @param string $binPath
134			*
135			* @throws SupportVectorMachineException
136			*/
137			public function setBinPath(string $binPath)
138			{
139			if (!is_dir($binPath)) {
140			throw SupportVectorMachineException::missingBinPath($binPath);
141			}
142
143			$binPath = realpath($binPath).DIRECTORY_SEPARATOR;
144
145			$trainFile = sprintf('%ssvm-train%s', $binPath, $this->getOSExtension());
146			$predictFile = sprintf('%ssvm-predict%s', $binPath, $this->getOSExtension());
147
148			if (!is_executable($trainFile)) {
149			throw SupportVectorMachineException::missingTrainFile($trainFile);
150			}
151
152			if (!is_executable($predictFile)) {
153			throw SupportVectorMachineException::missingPredictFile($predictFile);
154			}
155
156			$this->binPath = $binPath;
157
158			return $this;
159			}
160
161			/**
162			* @param string $varPath
163			*
164			* @throws SupportVectorMachineException
165			*/
166			public function setVarPath(string $varPath)
167			{
168			if (!is_dir($varPath)) {
169			throw SupportVectorMachineException::missingVarPath($varPath);
170			}
171
172			$varPath = realpath($varPath).DIRECTORY_SEPARATOR;
173
174			$this->varPath = $varPath;
175
176			return $this;
177			}
178
179			/**
180			* @param array $samples
181			* @param array $targets
182			*/
183			public function train(array $samples, array $targets)
184			{
185			$this->samples = array_merge($this->samples, $samples);
186			$this->targets = array_merge($this->targets, $targets);
187
188			$trainingSet = DataTransformer::trainingSet($this->samples, $this->targets, in_array($this->type, [Type::EPSILON_SVR, Type::NU_SVR]));
189			file_put_contents($trainingSetFileName = $this->varPath.uniqid('phpml', true), $trainingSet);
190			$modelFileName = $trainingSetFileName.'-model';
191
192			$command = $this->buildTrainCommand($trainingSetFileName, $modelFileName);
193			$output = '';
194			exec(escapeshellcmd($command), $output);
195
196			$this->model = file_get_contents($modelFileName);
197
198			unlink($trainingSetFileName);
199			unlink($modelFileName);
200			}
201
202			/**
203			* @return string
204			*/
205			public function getModel()
206			{
207			return $this->model;
208			}
209
210			/**
211			* @param array $samples
212			*
213			* @return array
214			*/
215			public function predict(array $samples)
216			{
217			$testSet = DataTransformer::testSet($samples);
218			file_put_contents($testSetFileName = $this->varPath.uniqid('phpml', true), $testSet);
219			file_put_contents($modelFileName = $testSetFileName.'-model', $this->model);
220			$outputFileName = $testSetFileName.'-output';
221
222			$command = sprintf('%ssvm-predict%s %s %s %s', $this->binPath, $this->getOSExtension(), $testSetFileName, $modelFileName, $outputFileName);
223			$output = '';
224			exec(escapeshellcmd($command), $output);
225
226			$predictions = file_get_contents($outputFileName);
227
228			unlink($testSetFileName);
229			unlink($modelFileName);
230			unlink($outputFileName);
231
232			if (in_array($this->type, [Type::C_SVC, Type::NU_SVC])) {
233			$predictions = DataTransformer::predictions($predictions, $this->targets);
234			} else {
235			$predictions = explode(PHP_EOL, trim($predictions));
236			}
237
238			if (!is_array($samples[0])) {
239			return $predictions[0];
240			}
241
242			return $predictions;
243			}
244
245			/**
246			* @return string
247			*/
248			private function getOSExtension()
249			{
250			$os = strtoupper(substr(PHP_OS, 0, 3));
251			if ($os === 'WIN') {
252			return '.exe';
253			} elseif ($os === 'DAR') {
254			return '-osx';
255			}
256
257			return '';
258			}
259
260			/**
261			* @param $trainingSetFileName
262			* @param $modelFileName
263			*
264			* @return string
265			*/
266			private function buildTrainCommand(string $trainingSetFileName, string $modelFileName): string
267			{
268			return sprintf('%ssvm-train%s -s %s -t %s -c %s -n %s -d %s%s -r %s -p %s -m %s -e %s -h %d -b %d %s %s',
269			$this->binPath,
270			$this->getOSExtension(),
271			$this->type,
272			$this->kernel,
273			$this->cost,
274			$this->nu,
275			$this->degree,
276			$this->gamma !== null ? ' -g '.$this->gamma : '',
277			$this->coef0,
278			$this->epsilon,
279			$this->cacheSize,
280			$this->tolerance,
281			$this->shrinking,
282			$this->probabilityEstimates,
283			escapeshellarg($trainingSetFileName),
284			escapeshellarg($modelFileName)
285			);
286			}
287			}
288

php-ai / php-ml

Pull Request — master (#88)

SupportVectorMachine::__construct() A

Complexity

Size

Duplication

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like