Class pyKnowledgeGraph

include/bind.h:237–314

template<class Index = size_t>
class pyKnowledgeGraph : public py::class_<graphvite::KnowledgeGraph<Index>> {
public:
    typedef graphvite::KnowledgeGraph<Index> KnowledgeGraph;
    typedef py::class_<KnowledgeGraph> Base;
    using Base::attr;
    using Base::def;
    using Base::def_readonly;

    template<class... Args>
    pyKnowledgeGraph(py::handle scope, const char *name, const Args &...args) :
            Base(scope, signature(name, typeid(Index).name()).c_str(), args...) {
        attr("__doc__") = "KnowledgeGraph(index_type=dtype.uint32)"
        R"(
        Knowledge graphs.

        Parameters:
            index_type (dtype): type of node indexes
        )";

        // override instance name with template name
        attr("__name__") = py::internal_str(name);
        attr("__qualname__") = py::internal_str(name);

        // data members
        def_readonly("num_vertex", &KnowledgeGraph::num_vertex);
        def_readonly("num_edge", &KnowledgeGraph::num_edge);
        def_readonly("num_relation", &KnowledgeGraph::num_relation);
        def_readonly("normalization", &KnowledgeGraph::normalization);
        def_readonly("entity2id", &KnowledgeGraph::entity2id, "Map of entity name to index.");
        def_readonly("relation2id", &KnowledgeGraph::relation2id, "Map of relation name to index.");
        def_readonly("id2entity", &KnowledgeGraph::id2entity, "Map of entity index to name.");
        def_readonly("id2relation", &KnowledgeGraph::id2relation, "Map of relation index to name.");

        // member functions
        def(py::init<>(), py::no_gil());

        def("load", &KnowledgeGraph::load_file, py::no_gil(),
            py::arg("file_name"), py::arg("normalization") = false, py::arg("delimiters") = " \t\r\n",
            py::arg("comment") = "#",
            "load(*args, **kwargs)"
            R"(
            Load a knowledge graph from a triplet-list file. Store the graph in an adjacency list.

            This function has 3 overloads

            .. function:: load(file_name, normalization=False, delimiters=' \\t\\r\\n', comment='#')
            .. function:: load(triplet_list, normalization=False)
            .. function:: load(weighted_triplet_list, normalization=False)

            Parameters:
                file_name (str): file name
                triplet_list (list of (str, str, str)): triplet list
                weighted_triplet_list (list of (str, str, str, float)): weighted triplet list
                normalization (bool, optional): normalize the adjacency matrix or not
                delimiters (str, optional): string of delimiter characters
                comment (str, optional): prefix of comment strings
            )");