Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.52 KB

validator.md

File metadata and controls

33 lines (21 loc) · 1.52 KB
Raw

Validator

The Validator validates an instance of kgx.graph.base_graph.BaseGraph for Biolink Model compliance.

To validate a graph,

from kgx.validator import Validator
v = Validator()
v.validate(graph)

Streaming Data Processing Mode

For very large graphs, the Validator operation may now successfully process graph data equally well using data streaming (command flag --stream=True) which significantly minimizes the memory footprint required to process such graphs.

Biolink Model Versioning

By default, the Validator validates against the latest Biolink Model release hosted by the current Biolink Model Toolkit; hwoever, one may override this default at the Validator class level using the Validator.set_biolink_model(version="#.#.#") where #.#.# is the major.minor.patch semantic versioning of the desired Biolink Model release.

Every instance of Validator() persistently assumes the most recently set class level Biolink Model version. Resetting the class level Biolink Model does not change the version of previously instantiated Validator() objects. In a multi-threaded environment instantiating multiple validator objects, it may be necessary to wrap the Validator.set_biolink_model and Validator() object instantiation together within a single thread locked block.

Note that the kgx validate CLI operation also has an optional biolink_release argument for the same purpose.

kgx.validator

.. automodule:: kgx.validator
   :members:
   :inherited-members:
   :show-inheritance: