Class pyLRSchedule

include/bind.h:757–798

Optimizer interface

// Optimizer interface
class pyLRSchedule : public py::class_<graphvite::LRSchedule> {
public:
    typedef graphvite::LRSchedule LRSchedule;
    typedef py::class_<LRSchedule> Base;
    using Base::def;
    using Base::def_readonly;

    template<class... Args>
    pyLRSchedule(py::handle scope, const char *name, const Args &...args) :
            Base(scope, name, args...) {
        attr("__doc__") = "LRSchedule(*args, **kwargs)"
        R"(
        Learning Rate Schedule.

        This class has 2 constructors

        .. function:: LRSchedule(type='constant')
        .. function:: LRSchedule(schedule_function)

        Parameters:
            type (str, optional): 'constant' or 'linear'
            schedule_function (callable): function that returns a multiplicative factor,
                given batch id and total number of batches
        )";

        // data members
        def_readonly("type", &LRSchedule::type);
        def_readonly("schedule_function", &LRSchedule::schedule_function);

        // member functions
        def(py::init<std::string>(), py::no_gil(),
            py::arg("type") = "constant");

        def(py::init<LRSchedule::ScheduleFunction>(), py::no_gil(),
            py::arg("schedule_function"));

        py::implicitly_convertible<std::string, graphvite::LRSchedule>();
        py::implicitly_convertible<LRSchedule::ScheduleFunction, graphvite::LRSchedule>();

        def("__repr__", &LRSchedule::info, py::no_gil());
    }
};

class pyOptimizer : public py::class_<graphvite::Optimizer> {
public: