itmo-nss-team/epde

EPDE - partial differential equations discovery framework

epde's Issues

naming by the PEP8

• наименование классов по примеру: MyClass
• наименование методов и функций по примеру: my_function_of_test

Create two branches

We need to create two branches - working one and with solver.

docstring of method

оформление docstrings для методов и функций в следующем виде:

"""
My numpydoc description of a kind
of very exhautive numpydoc format docstring.

Parameters
----------
first : array_like
    the 1st param name `first`
second :
    the 2nd param
third : {'value', 'other'}, optional
    the 3rd param, by default 'value'

Returns
-------
string
    a value in a string

Raises
------
KeyError
    when a key error
OtherError
    when an other error
"""

• если ничего не возвращается то либо нет раздела Returns, либо в нём None:

Returns
-------
None

• Raises указывать при необходимости

No error message if boundaries parameter larger than data size.

Algorithm continue its work if EpdeSearch object has boundary parameter >=len(coordinate_tensors), so the optimization is done using zero points.

Make sure all examples work with current code

Make sure that everything works, remove or mark depreciate examples.

Github actions for automatic PyPi synchronization

Use all knowledge we obtained to make some automatization

Shiny badges

Make repository great and add all possible badges. More badges - better repo.

refactor some block of code

Подумать на счёт переорганизации одного билдера и двух директоров в одного директора и два билдера для 2-х оптимизационных стратегий.

Folder "optimizer"

First version of the documentation

Gather everything we know, summarize and put all together.

Add mark to repository

We need to invite Mark

Gitlab -> Github transfer

We need to transfer code from gitlab to github and see if everything works.

docstring of class

оформить docstring к классам в следующем виде:

    """
    A class to represent a person.

    ...

    Attributes
    ----------
    name : str
        first name of the person
    surname : str
        family name of the person
    age : int
        age of the person

    Methods
    -------
    info(additional=""):
        Prints the person's name and age.
    """

• наверное прописывание docstring для init в таком случае будет лишнее
• на счёт как лучше сделать, описать Methods для класса или будет достаточно docstring в самих методах: это в зависимости от класса