Skip to content

Commit

Permalink
added comment on integration test reference file locations
Browse files Browse the repository at this point in the history
  • Loading branch information
karlnapf committed Mar 13, 2016
1 parent e1c923c commit fed6c40
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/cookbook/README.md
Expand Up @@ -18,7 +18,7 @@ To add an entry, only two files are needed (plus a test):

* A Sphinx markdown file with matching filename and directory, e.g. ```shogun/doc/sphinx/source/examples/classifier/knn.rst```. This file contains a description of the API example and references to code snippets. The point is to *not* show the full file listing but only a subset. The file should furthermore contain basic math in the form of LaTeX, important references (wikipedia, scientific paper references using BibTeX, etc), and links to the involved Shogun class documentation, github issues, etc. We use Sphinx tags to make this easy, see for example [knn.rst](https://github.com/shogun-toolbox/shogun/blob/develop/doc/cookbook/source/examples/classifier/knn.rst).

* All added meta examples are part of Shogun's integration testing. All numerical output (vector, matrix, real) is serialized to file at the end of each example. You might have to [put results in a variable](https://github.com/shogun-toolbox/shogun/blob/develop/examples/meta/src/classifier/knn.sg#L28) if they are hidden within a Shogun object. Have a look at the generated listings to see how. You can easily add a generated file to the [data](https://github.com/shogun-toolbox/shogun-data/tree/master/testsuite/meta/) repository. Once added, all future results of a test file will be compared to this reference file. Note as opposed to the old integration testing system in pace, only *numerical* outputs are compared. Please keep the example output files small.
* All added meta examples are part of Shogun's integration testing. All numerical output (vector, matrix, real) is serialized to file at the end of each example. You might have to [put results in a variable](https://github.com/shogun-toolbox/shogun/blob/develop/examples/meta/src/classifier/knn.sg#L28) if they are hidden within a Shogun object. Have a look at the generated listings to see how. You can easily add a generated file to the [data](https://github.com/shogun-toolbox/shogun-data/tree/master/testsuite/meta/) repository. For now, use the results generated by the `cpp` examples in `build/tests/meta/generated_results/cpp/`. Once added, all future results of a test file will be compared to this reference file. Note as opposed to the old integration testing system in pace, only *numerical* outputs are compared. Please keep the example output files small.

## Guidelines

Expand Down

0 comments on commit fed6c40

Please sign in to comment.