mention convert_yaml_to_hdf5() in README and change manual to

`tutorial` in `central_metadata`
nilmtk · Jul 2, 2014 · f7c45aa · f7c45aa
1 parent 303948a
commit f7c45aa
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -69,6 +69,8 @@ embrace the
 ["don't repeat yourself (DRY)"](http://en.wikipedia.org/wiki/Don%27t_repeat_yourself)
 principal by exploiting the relationship between appliances.
 
+### Python utilities
+
 NILM Metadata comes with a Python module which collects all 
 ApplianceTypes in `central_metadata/appliance_types/*.yaml`,
 performs inheritance and instantiates components and
@@ -80,6 +82,10 @@ from nilm_metadata import get_appliance_types
 appliance_types = get_appliance_types()
 ```
 
+NILM Metadata also comes with a `convert_yaml_to_hdf5()` function
+which will convert a YAML instance of NILM Metadata to the HDF5 file
+format.
+
 ## Research paper describing NILM metadata
 
 The following paper describes NILM metadata in detail:

diff --git a/docs/source/central_metadata.rst b/docs/source/central_metadata.rst
@@ -144,7 +144,7 @@ showing all the classes and the relationships between classes:
 
 .. image:: schema.svg
 
-(Please see the :doc:`manual` for more background about the NILM
+(Please see the :doc:`tutorial` for more background about the NILM
 Metadata schema)
 
 Below we describe all the classes and their attributes and possible values.