<commit_before>Tachyon-Perf
============

A general performance test framework for [Tachyon](http://tachyon-project.org/).

##Run Tachyon-Perf Tests
The following steps show how to run a Tachyon-Perf test. 

1. Copy `perf/conf/tachyon-perf-env.sh.template` to `perf/conf/tachyon-perf-env.sh` and configure it as prompted.
2. Edit `perf/conf/slaves` to add testing slave nodes. It's recommended to be the same as `{tachyon.home}/conf/workers`. By the way, duplicate slave name is allowed which implies start multi-processes tests on one slave node.
3. The running test command is `perf/bin/tachyon-perf <TestCase>`
 * The parameter is the name of test case, and now it should be `Metadata`, `SimpleWrite`, `SimpleRead`, `SkipRead`, `Mixture` or `Iterate`.
 * The test's configurations are in `conf/testSuite/<TestCase>.xml`, and you can modify it as your wish.
4. When TachyonPerf is running, the status of the testing job will be collected and printed on the console. For some reasons, if you want to abort the tests, you can just press `Ctrl + C` to terminate it and then type the command `perf/bin/tachyon-perf-abort` on the master node to abort test processes on each slave node.<commit_msg>update README of perf module<commit_after>Tachyon-Perf
============

A general performance test framework for [Tachyon](http://tachyon-project.org/).

##Compile

If you want to test Tachyon's UnderFileSystem, for example, S3UnderFileSystem, you need to add the following
dependencies to perf/pom.xml:

    <dependency>
      <groupId>org.tachyonproject</groupId>
      <artifactId>tachyon-underfs-s3</artifactId>
      <version>${project.version}</version>
      <scope>compile</scope>
    </dependency>

##Run Tachyon-Perf Tests
The following steps show how to run a Tachyon-Perf test. 

1. Copy `perf/conf/tachyon-perf-env.sh.template` to `perf/conf/tachyon-perf-env.sh` and configure it as prompted.
2. Edit `perf/conf/slaves` to add testing slave nodes. It's recommended to be the same as `{tachyon.home}/conf/workers`. By the way, duplicate slave name is allowed which implies start multi-processes tests on one slave node.
3. The running test command is `perf/bin/tachyon-perf <TestCase>`
 * The parameter is the name of test case, and now it should be `Metadata`, `SimpleWrite`, `SimpleRead`, `SkipRead`, `Mixture` or `Iterate`.
 * The test's configurations are in `conf/testSuite/<TestCase>.xml`, and you can modify it as your wish.
4. When TachyonPerf is running, the status of the testing job will be collected and printed on the console. For some reasons, if you want to abort the tests, you can just press `Ctrl + C` to terminate it and then type the command `perf/bin/tachyon-perf-abort` on the master node to abort test processes on each slave node.
{'fraction_non_alphanumeric': 0.10192237939789626, 'fraction_numerical': 0.003627130939426913, 'mean_word_length': 4.334622823984526, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 17, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 3}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3657075', 'n_tokens_mistral': 848, 'n_tokens_neox': 798, 'n_words': 353}