Java Sketch Characterization Code.

Clone this repo:
  1. 11e6743 [Go] Add FrequencyLong speed profile by Pierre Lacave · 2 days ago master
  2. bb80721 Merge pull request #65 from apache/hll-serde-go by Pierre Lacave · 3 days ago
  3. 3b9de54 [Go] Add HLL SerDe profile by Pierre Lacave · 12 days ago
  4. d9d6706 Merge pull request #64 from apache/go-hll-merge-speed-profile by Pierre Lacave · 12 days ago
  5. d9bf9be [Go] add no error assert in distinct count merge speed profile by Pierre Lacave · 3 weeks ago

Characterizations of Java, C++ & Go Library Components

Please visit the main DataSketches website for more information.

If you are interested in making contributions to this site please see our Community page for how to contact us.

We define characterization as the task of comprehensively measuring accuracy or speed performance of various library components over a wide range of inputs. The output from characterization tests are huge tables of numbers with hundreds or thousands of rows. These are then converted into graphs and charts for close examination of behavior. This is different from benchmarking, which is usually focused on testing performance of a given configuration against a single or small set of thresholds for a pass / fail result.

These characterization tests are often long running (some can run for many hours or a few days) and very resource intensive, which makes them unsuitable for including in unit tests. The reason for the long running times is that sketches are stochastic in nature and it takes thousands to millions of trials to reduce the statistical noise in order to produce relatively smooth graphs that we can then analyze.

The code in this repository are the test suites we use to create most of the plots on our website and provide evidence for our speed and accuracy claims. This code is shared here so that others can duplicate our characterizations.

This code is shared “as-is” and does not pretend to have the same level of quality as the primary repositories (java, C++, Go). This code is not formally released nor archived to Maven Central and will change from time-to-time as we grow these characterization suites. At any point in time this code is not necessarily up-to-date with the latest releases and thus may require some tweeking to get it to compile.

Caveat Emptor, and enjoy!

Build / Run Instructions (Java)

JDK8 with HotSpot is required to compile

This Java classes of this DataSketches component must be compiled using JDK 8.

Recommended Build Tool

This DataSketches component is structured as a Maven project and Maven is the recommended Build Tool.

There are two types of tests: normal unit tests and tests run by the strict profile.

To run normal unit tests:

$ mvn clean test

To run the strict profile tests:

$ mvn clean test -P strict

Dependencies

Run-time

See the pom.xml for the top-level dependencies.

Testing

See the pom.xml file for test dependencies.

Run

  • The characterization tests are called profiles and are located by type under the directories:
    • src/main/java/org/apache/datasketches/characterization/<type>/<test>.java
  • These tests have many parameters that are specified in a corresponding configuration “.conf” file located in directories:
    • src/main/resources/<type>/<test>.conf
    • One of the parameters specified by the .conf file is the specific “Job Profile” that is to be run using that configuration.
  • It is recommended that you use your IDE and run the test by executing org.apache.datasketches.job.main(<location of .conf file>). The IDE should resolve all the required dependencies specified by the pom.xml file for you. With Eclipse, the command is “run as java application”. IntelliJ should have something similar. The output is sent to Standard Out.

Build Instructions (C++)

Using Eclipse

Installing CDT

If you already have Eclipse you will need to install the CDT extensions, or you can install Eclipse with CDT only. We had to upgrade our Eclipse to the latest version before we could successfully install the CDT extensions.

Setting up the Eclipse Project

We have found it convenient to setup two projects in Eclipse:

  • Java project: where the root directory is the root of your local copy of the datasketches-characterization repository. We named it “datasketches-characterization”.
  • C++ project: where the root directory is the cpp directory just under the Java project root. We named it “datasketches-characterization-CPP”.

Choosing the Tool Chain

After your project is created, open Project Properties

  • C/C++ Build In this menu select Use default build command, Generate Makefiles automatically, and Expand Env. Variable Refs in Makefiles.

    • Tool Chain Editor Choose the compatible tool chain for your system. We use MacOSX GCC and Gnu Make Builder.
    • Settings/Tool Settings
      • GCC C++ Compiler
        • Dialect Other dialect flags: “-std=c++11”
        • Includes Select from the directory where you have datasketches-cpp installed. Then add complete paths for:
          • .../datasketches-cpp/common/include
          • .../datasketches-cpp/cpc/include
          • .../datasketches-cpp/fi/include
          • .../datasketches-cpp/hll/include
          • .../datasketches-cpp/kll/include
          • .../datasketches-cpp/theta/include
        • Optimization
          • Optimization Level Optimize most (-O3)
          • Other optimization flags “-DNDEBUG”
        • Warnings Check All Warnings (-Wall)
        • Miscellaneous Other flags “-c fmessage-length=0”
  • C/C++ General

    • Paths and Symbols Tab: Source Locations, Action: Add Folder...: Add reference to “/datasketches-characterization_CPP/src”

Build Project

After this setup you should be able to Build Project from the top-level Eclipse / Project Menu. You may need to unselect the Build Automatically option.

Build Instructions (Go)

Dependencies

  • Go 1.21 or later is required to compile the Go code.

Build

  • The project uses Go modules, so you can build the project by running the following command:
    go build
    

Run

  • The project has a main function that runs the characterization tests. You can run the tests by running the following command:

    ./datasketches-characterization-go <job name>
    

    or alternatively:

    go run . <job name>
    

    The list of available jobs can be found in the usage of the program:

    ./datasketches-characterization-go