Skip to content

StarlangSoftware/Math-Cy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Video Lectures

For Developers

You can also see Python, Java, C++, C, Swift, Js, Php, or C# repository.

Requirements

Python

To check if you have a compatible version of Python installed, use the following command:

python -V

You can find the latest version of Python here.

Git

Install the latest version of Git.

Pip Install

pip3.9 install NlpToolkit-Math-Cy

Download Code

In order to work on code, create a fork from GitHub page. Use Git for cloning the code to your local or below line for Ubuntu:

git clone <your-fork-git-link>

A directory called Math will be created. Or you can use below link for exploring the code:

git clone https://github.com/starlangsoftware/Math-Cy.git

Open project with Pycharm IDE

Steps for opening the cloned project:

  • Start IDE
  • Select File | Open from main menu
  • Choose Math-CY file
  • Select open as project option
  • Couple of seconds, dependencies will be downloaded.

Detailed Description

Vector

Bir vektör yaratmak için:

Vector(self, values=None)

Vektörler eklemek için

addVector(self, v: Vector)

Çıkarmak için

subtract(self, v: Vector)
difference(self, v: Vector) -> Vector

İç çarpım için

dotProduct(self, v: Vector) -> float
dotProductWithSelf(self) -> float

Bir vektörle cosinüs benzerliğini hesaplamak için

double cosineSimilarity(Vector v)

Bir vektörle eleman eleman çarpmak için

elementProduct(self, v: Vector) -> Vector

Matrix

3'e 4'lük bir matris yaratmak için

a = Matrix(3, 4)

Elemanları rasgele değerler alan bir matris yaratmak için

Matrix(self, row, col, minValue=None, maxValue=None)

Örneğin,

a = Matrix(3, 4, 1, 5)

3'e 4'lük elemanları 1 ve 5 arasında değerler alan bir matris yaratır.

Matrisin i. satır, j. sütun elemanını getirmek için

getValue(self, rowNo: int, colNo: int) -> float

Örneğin,

a.getValue(3, 4)
  1. satır, 4. sütundaki değeri getirir.

Matrisin i. satır, j. sütunundaki elemanı değiştirmek için

setValue(self, rowNo: int, colNo: int, value: float)

Örneğin,

a.setValue(3, 4, 5)
  1. satır, 4.sütundaki elemanın değerini 5 yapar.

Matrisleri toplamak için

add(self, m: Matrix)

Çıkarmak için

subtract(self, m: Matrix)

Çarpmak için

multiply(self, m: Matrix) -> Matrix

Elaman eleman matrisleri çarpmak için

elementProduct(self, m: Matrix) -> Matrix

Matrisin transpozunu almak için

transpose(self) -> Matrix

Matrisin simetrik olup olmadığı belirlemek için

isSymmetric(self) -> bool

Determinantını almak için

determinant(self) -> float

Tersini almak için

inverse(self)

Matrisin eigenvektör ve eigendeğerlerini bulmak için

characteristics(self) -> list

Bu metodla bulunan eigenvektörler eigendeğerlerine göre büyükten küçüğe doğru sıralı olarak döndürülür.

Distribution

Verilen bir değerin normal dağılımdaki olasılığını döndürmek için

zNormal(z: float) -> float

Verilen bir olasılığın normal dağılımdaki değerini döndürmek için

zInverse(p: float) -> float

Verilen bir değerin chi kare dağılımdaki olasılığını döndürmek için

chiSquare(x: float, freedom: int) -> float

Verilen bir olasılığın chi kare dağılımdaki değerini döndürmek için

chiSquareInverse(p: float, freedom: int) -> float

Verilen bir değerin F dağılımdaki olasılığını döndürmek için

fDistribution(F: float, freedom1: int, freedom2: int) -> float

Verilen bir olasılığın F dağılımdaki değerini döndürmek için

fDistributionInverse(p: float, freedom1: int, freedom2: int) -> float

Verilen bir değerin t dağılımdaki olasılığını döndürmek için

tDistribution(T: float, freedom: int) -> float

Verilen bir olasılığın t dağılımdaki değerini döndürmek için

tDistributionInverse(p: float, freedom: int) -> float

For Contibutors

Setup.py file

  1. Do not forget to set package list. All subfolders should be added to the package list.
    packages=['Classification', 'Classification.Model', 'Classification.Model.DecisionTree',
              'Classification.Model.Ensemble', 'Classification.Model.NeuralNetwork',
              'Classification.Model.NonParametric', 'Classification.Model.Parametric',
              'Classification.Filter', 'Classification.DataSet', 'Classification.Instance', 'Classification.Attribute',
              'Classification.Parameter', 'Classification.Experiment',
              'Classification.Performance', 'Classification.InstanceList', 'Classification.DistanceMetric',
              'Classification.StatisticalTest', 'Classification.FeatureSelection'],
  1. Package name should be lowercase and only may include _ character.
    name='nlptoolkit_math',
  1. Package data should be defined and must ibclude pyx, pxd, c and py files.
    package_data={'NGram': ['*.pxd', '*.pyx', '*.c', '*.py']},
  1. Setup should include ext_modules with compiler directives.
    ext_modules=cythonize(["NGram/*.pyx"],
                          compiler_directives={'language_level': "3"}),

Cython files

  1. Define the class variables and class methods in the pxd file.
cdef class DiscreteDistribution(dict):

    cdef float __sum

    cpdef addItem(self, str item)
    cpdef removeItem(self, str item)
    cpdef addDistribution(self, DiscreteDistribution distribution)
  1. For default values in class method declarations, use *.
    cpdef list constructIdiomLiterals(self, FsmMorphologicalAnalyzer fsm, MorphologicalParse morphologicalParse1,
                               MetamorphicParse metaParse1, MorphologicalParse morphologicalParse2,
                               MetamorphicParse metaParse2, MorphologicalParse morphologicalParse3 = *,
                               MetamorphicParse metaParse3 = *)
  1. Define the class name as cdef, class methods as cpdef, and __init__ as def.
cdef class DiscreteDistribution(dict):

    def __init__(self, **kwargs):
        """
        A constructor of DiscreteDistribution class which calls its super class.
        """
        super().__init__(**kwargs)
        self.__sum = 0.0

    cpdef addItem(self, str item):
  1. Do not forget to comment each function.
    cpdef addItem(self, str item):
        """
        The addItem method takes a String item as an input and if this map contains a mapping for the item it puts the
        item with given value + 1, else it puts item with value of 1.

        PARAMETERS
        ----------
        item : string
            String input.
        """
  1. Function names should follow caml case.
    cpdef addItem(self, str item):
  1. Local variables should follow snake case.
	det = 1.0
	copy_of_matrix = copy.deepcopy(self)
  1. Variable types should be defined for function parameters, class variables.
    cpdef double getValue(self, int rowNo, int colNo):
  1. Local variables should be defined with types.
    cpdef sortDefinitions(self):
        cdef int i, j
        cdef str tmp
  1. For abstract methods, use ABC package and declare them with @abstractmethod.
    @abstractmethod
    def train(self, train_set: list[Tensor]):
        pass
  1. For private methods, use __ as prefix in their names.
    cpdef list __linearRegressionOnCountsOfCounts(self, list countsOfCounts)
  1. For private class variables, use __ as prefix in their names.
cdef class NGram:
    cdef int __N
    cdef double __lambda1, __lambda2
    cdef bint __interpolated
    cdef set __vocabulary
    cdef list __probability_of_unseen
  1. Write __repr__ class methods as toString methods
  2. Write getter and setter class methods.
    cpdef int getN(self)
    cpdef setN(self, int N)
  1. If there are multiple constructors for a class, define them as constructor1, constructor2, ..., then from the original constructor call these methods.
cdef class NGram:

    cpdef constructor1(self, int N, list corpus):
    cpdef constructor2(self, str fileName):
    def __init__(self,
                 NorFileName,
                 corpus=None):
        if isinstance(NorFileName, int):
            self.constructor1(NorFileName, corpus)
        else:
            self.constructor2(NorFileName)
  1. Extend test classes from unittest and use separate unit test methods.
class NGramTest(unittest.TestCase):

    def test_GetCountSimple(self):
  1. For undefined types use object as type in the type declarations.
cdef class WordNet:

    cdef object __syn_set_list
    cdef object __literal_list
  1. For boolean types use bint as type in the type declarations.
	cdef bint is_done
  1. Enumerated types should be used when necessary as enum classes, and should be declared in py files.
class AttributeType(Enum):
    """
    Continuous Attribute
    """
    CONTINUOUS = auto()
    """
  1. Resource files should be taken from pkg_recources package.
	fileName = pkg_resources.resource_filename(__name__, 'data/turkish_wordnet.xml')

About

Math library

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors