Skip to content
Permalink
Browse files
Remove "incubat*" everywhere except for a dependency.
Update .asf.yaml
update NOTICE, pom.xml, README.md
remove DISCLAIMER-WIP
  • Loading branch information
leerho committed Jan 11, 2021
1 parent c91bc3b commit 43f443a809e44b7f6396fe45faad3f0a3c1995ab
Showing 6 changed files with 78 additions and 120 deletions.
@@ -1,17 +1,2 @@
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

github:
homepage: https://datasketches.apache.org

This file was deleted.

2 NOTICE
@@ -1,4 +1,4 @@
Apache DataSketches Pig (incubating)
Apache DataSketches Pig
Copyright 2020 - The Apache Software Foundation

Copyright 2015-2018 Yahoo
@@ -17,11 +17,11 @@
under the License.
-->

[![Build Status](https://travis-ci.org/apache/incubator-datasketches-pig.svg?branch=master)](https://travis-ci.org/apache/incubator-datasketches-pig)
[![Build Status](https://travis-ci.org/apache/datasketches-pig.svg?branch=master)](https://travis-ci.org/apache/datasketches-pig)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.datasketches/datasketches-pig/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.datasketches/datasketches-pig)
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/apache/incubator-datasketches-pig.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/incubator-datasketches-pig/context:java)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/apache/incubator-datasketches-pig.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/incubator-datasketches-pig/alerts/)
[![Coverage Status](https://coveralls.io/repos/github/apache/incubator-datasketches-pig/badge.svg?branch=master)](https://coveralls.io/github/apache/incubator-datasketches-pig?branch=master)
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/apache/datasketches-pig.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/datasketches-pig/context:java)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/apache/datasketches-pig.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/apache/datasketches-pig/alerts/)
[![Coverage Status](https://coveralls.io/repos/github/apache/datasketches-pig/badge.svg?branch=master)](https://coveralls.io/github/apache/datasketches-pig?branch=master)

=================

@@ -59,11 +59,11 @@ To install jars built from the downloaded source:

This will create the following jars:

* datasketches-pig-X.Y.Z-incubating.jar The compiled main class files.
* datasketches-pig-X.Y.Z-incubating-tests.jar The compiled test class files.
* datasketches-pig-X.Y.Z-incubating-sources.jar The main source files.
* datasketches-pig-X.Y.Z-incubating-test-sources.jar The test source files
* datasketches-pig-X.Y.Z-incubating-javadoc.jar The compressed Javadocs.
* datasketches-pig-X.Y.Z.jar The compiled main class files.
* datasketches-pig-X.Y.Z-tests.jar The compiled test class files.
* datasketches-pig-X.Y.Z-sources.jar The main source files.
* datasketches-pig-X.Y.Z-test-sources.jar The test source files
* datasketches-pig-X.Y.Z-javadoc.jar The compressed Javadocs.

### Dependencies

@@ -78,6 +78,3 @@ This has the following top-level dependencies:
#### Testing
See the pom.xml file for test dependencies.

----

Disclaimer: Apache DataSketches is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
123 pom.xml
@@ -1,4 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -17,55 +18,30 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.apache</groupId>
<artifactId>apache</artifactId>
<version>21</version>
<version>23</version>
</parent>

<groupId>org.apache.datasketches</groupId>

<!-- UNIQUE FOR THIS JAVA COMPONENT -->
<artifactId>datasketches-pig</artifactId>
<version>1.1.0-incubating-SNAPSHOT</version>
<version>1.1.0-SNAPSHOT</version>
<description>Apache Pig adaptors for the DataSketches library.</description>
<!-- END: UNIQUE FOR THIS JAVA COMPONENT -->

<url>https://datasketches.apache.org/</url>
<name>${project.artifactId}</name>
<inceptionYear>2015</inceptionYear>
<packaging>jar</packaging>
<!-- jar is the default -->
<!-- With the 3.6.1 version of Maven this causes a warning to obsolete this in
favor of using the enforcer plugin (which we do). But removing this
causes the command "mvn versions:display-plugin-updates" to issue an error
and not work properly. So this will stay for the time being.
-->
<prerequisites>
<maven>3.2.0</maven>
</prerequisites>
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0</url>
<distribution>repo</distribution>
</license>
</licenses>
<scm>
<connection>scm:git:ssh://git@github.com/apache/incubator-${project.artifactId}.git</connection>
<developerConnection>scm:git:ssh://git@github.com/apache/incubator-${project.artifactId}.git</developerConnection>
<url>https://github.com/apache/incubator-${project.artifactId}</url>
<tag>HEAD</tag>
</scm>
<issueManagement>
<!-- <system>jira</system>
<url>https://issues.apache.org/jira/browse/DATASKETCHES</url> -->
<system>GitHub</system>
<url>https://github.com/apache/incubator-${project.artifactId}/issues</url>
</issueManagement>
<packaging>jar</packaging> <!-- jar is the default -->

<mailingLists>
<mailingList>
<name>DataSketches Developers</name>
@@ -82,6 +58,21 @@ under the License.
<post>mailto:sketches-user@googlegroups.com</post>
</mailingList>
</mailingLists>

<scm>
<connection>scm:git:ssh://git@github.com/apache/${project.artifactId}.git</connection>
<developerConnection>scm:git:ssh://git@github.com/apache/${project.artifactId}.git</developerConnection>
<url>https://github.com/apache/${project.artifactId}</url>
<tag>HEAD</tag>
</scm>

<issueManagement>
<!-- <system>jira</system>
<url>https://issues.apache.org/jira/browse/DATASKETCHES</url> -->
<system>GitHub</system>
<url>https://github.com/apache/${project.artifactId}/issues</url>
</issueManagement>

<developers>
<developer>
<name>The Apache DataSketches Team</name>
@@ -91,50 +82,54 @@ under the License.
<organizationUrl>http://www.apache.org</organizationUrl>
</developer>
</developers>
<properties>

<properties>
<!-- UNIQUE FOR THIS JAVA COMPONENT -->
<datasketches-java.version>1.1.0-incubating</datasketches-java.version>
<datasketches-java.version>1.3.0-incubating</datasketches-java.version>
<pig.version>0.17.0</pig.version>
<hadoop-common.version>2.8.5</hadoop-common.version>
<commons-math3.version>3.6.1</commons-math3.version>
<!-- END:UNIQUE FOR THIS JAVA COMPONENT -->

<!-- Test -->
<testng.version>6.14.3</testng.version>
<testng.version>7.1.0</testng.version>

<!-- System-wide properties -->
<maven.version>3.0.0</maven.version>
<java.version>1.8</java.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<argLine>-Xmx4g -Duser.language=en -Duser.country=US -Dfile.encoding=UTF-8</argLine>
<charset.encoding>UTF-8</charset.encoding>
<project.build.sourceEncoding>${charset.encoding}</project.build.sourceEncoding>
<project.build.resourceEncoding>${charset.encoding}</project.build.resourceEncoding>
<project.reporting.outputEncoding>${charset.encoding}</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>

<!-- org.codehaus.plexus used for strict profile testing-->
<plexus-compiler-javac-errorprone.version>2.8.5</plexus-compiler-javac-errorprone.version>
<plexus-compiler-javac-errorprone.version>2.8.8</plexus-compiler-javac-errorprone.version>
<!-- Maven Plugins -->
<maven-assembly-plugin.version>3.1.1</maven-assembly-plugin.version>
<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
<maven-deploy-plugin.version>3.0.0-M1</maven-deploy-plugin.version>
<maven-enforcer-plugin.version>3.0.0-M2</maven-enforcer-plugin.version>
<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
<maven-jar-plugin.version>3.1.2</maven-jar-plugin.version>
<maven-javadoc-plugin.version>3.1.1</maven-javadoc-plugin.version>
<maven-release-plugin.version>2.5.3</maven-release-plugin.version>
<maven-remote-resources-plugin.version>[1.0,)</maven-remote-resources-plugin.version>
<maven-source-plugin.version>3.1.0</maven-source-plugin.version>
<maven-surefire-plugin.version>3.0.0-M3</maven-surefire-plugin.version>
<maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version> <!-- overrides parent -->
<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version> <!-- overrides parent -->
<maven-deploy-plugin.version>3.0.0-M1</maven-deploy-plugin.version> <!-- overrides parent -->
<maven-enforcer-plugin.version>3.0.0-M2</maven-enforcer-plugin.version> <!-- overrides parent -->
<maven-gpg-plugin.version>1.6</maven-gpg-plugin.version> <!-- overrides parent -->
<maven-jar-plugin.version>3.2.0</maven-jar-plugin.version> <!-- overrides parent -->
<maven-javadoc-plugin.version>3.2.0</maven-javadoc-plugin.version> <!-- overrides parent -->
<maven-release-plugin.version>3.0.0-M1</maven-release-plugin.version> <!-- overrides parent -->
<maven-remote-resources-plugin.version>[1.7.0,)</maven-remote-resources-plugin.version> <!-- overrides parent -->
<maven-source-plugin.version>3.2.1</maven-source-plugin.version> <!-- overrides parent -->
<maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version> <!-- overrides parent -->
<!-- Apache Plugins -->
<apache-rat-plugin.version>0.13</apache-rat-plugin.version>
<apache-rat-plugin.version>0.13</apache-rat-plugin.version> <!-- overrides parent -->
<!-- org.jacoco Maven Plugins -->
<jacoco-maven-plugin.version>0.8.4</jacoco-maven-plugin.version>
<jacoco-maven-plugin.version>0.8.6</jacoco-maven-plugin.version>
<!-- org.eluder Maven Plugins -->
<coveralls-maven-plugin.version>4.3.0</coveralls-maven-plugin.version>
<!-- other -->
<lifecycle-mapping.version>1.0.0</lifecycle-mapping.version>
<git-commit-id-plugin.version>3.0.0</git-commit-id-plugin.version>
</properties>

<repositories>
<repository>
<id>apache.snapshots</id>
@@ -159,8 +154,8 @@ under the License.
</snapshots>
</repository>
</repositories>
<dependencies>

<dependencies>
<!-- UNIQUE FOR THIS JAVA COMPONENT -->
<dependency>
<groupId>org.apache.datasketches</groupId>
@@ -202,6 +197,7 @@ under the License.
<scope>test</scope>
</dependency>
</dependencies>

<build>
<pluginManagement>
<plugins>
@@ -272,10 +268,10 @@ under the License.
<configuration>
<rules>
<requireJavaVersion>
<version>1.8.0</version>
<version>${java.version}</version>
</requireJavaVersion>
<requireMavenVersion>
<version>3.2,</version>
<version>${maven.version},</version>
</requireMavenVersion>
<bannedDependencies>
<excludes>
@@ -309,9 +305,9 @@ under the License.
<excludes>
<!-- rat uses .gitignore for excludes by default -->
<exclude>**/test/resources/**/*.txt</exclude>
<exclude>.asf.yaml</exclude>
<exclude>LICENSE</exclude>
<exclude>NOTICE</exclude>
<exclude>DISCLAIMER-WIP</exclude>
</excludes>
</configuration>
</plugin>
@@ -462,6 +458,7 @@ under the License.
</pluginManagement>
</build>
</profile>

<profile>
<id>strict</id>
<build>
@@ -489,11 +486,12 @@ under the License.
</pluginManagement>
</build>
</profile>

<!-- This profile is used to release signed jars to the Apache Nexus repository.
This must be executed from a git repository set at the proper Release branch (e.g., 1.1.X-incubating)
and at a Release Candidate tag (e.g., 1.1.0-incubating-RC1).
The pom version in the release branch must be properly set to something like: "1.1.0-incubating".
The pom version in the master would be set to something like: "1.2.0-incubating-SNAPSHOT".
This must be executed from a git repository set at the proper Release branch (e.g., 1.1.X)
and at a Release Candidate tag (e.g., 1.1.0-RC1).
The pom version in the release branch must be properly set to something like: "1.1.0".
The pom version in the master would be set to something like: "1.2.0-SNAPSHOT".
Test Command: mvn clean verify -Pnexus-jars -DskipTests=true
Command: mvn clean deploy -Dnexus-jars
Verify Command (from terminal): gpg -v &#45;&#45;verify $ASC $FILE # dashdashverify
@@ -543,6 +541,7 @@ under the License.
</gitDescribe>
</configuration>
</plugin>

<!-- Extends Apache Parent pom, pluginManagement-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -584,6 +583,7 @@ under the License.
</archive>
</configuration>
</plugin>

<!-- We want to sign the artifacts, POM, and all attached artifacts -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -608,6 +608,7 @@ under the License.
</plugin>
</plugins>
</pluginManagement>

<plugins>
<plugin>
<groupId>pl.project13.maven</groupId>
@@ -31,7 +31,7 @@ <h3><a name="accuracy">Sketch Accuracy</a></h3>

<h3><a name="alphaTCF">Alpha TCF</a></h3>
The Alpha Theta Choosing Function (TCF) and the theory behind it is fully described in the
<a href="https://github.com/DataSketches/DataSketches.apache.org/blob/master/docs/pdf/ThetaSketchFramework.pdf">Theta Sketch Framework</a> paper.
<a href="https://github.com/apache/datasketches-website/blob/master/docs/pdf/ThetaSketchFramework.pdf">Theta Sketch Framework</a> paper.
The alpha algorithm is optimized for speed and accuracy in a real-time sketch
building / estimating environment.
<p>One of the properties of the Alpha Algorithm used for cache management within a sketch is that
@@ -80,9 +80,10 @@ <h3><a name="dirtyHash">Dirty Hash</a></h3>
<h3><a name="empty">isEmpty()</a></h3>
In Theta Sketches, the state <i>isEmpty()</i> for a sketch means that the sketch cache has zero hash values and that none of the
update methods have been called with valid data. In other words, the sketch has never seen any data.
This state is equivalent to "null" in the sense that it is safe to exclude empty sketches from set operations.
This state is equivalent to "null" in the sense that it is safe to exclude empty sketches from union operations. However, an empty sketch
will impact intersections and difference set operations.

<p>Note that <i>isEmpty()</i> does not mean that theta is 1.0 because if <i>p</i> &lt; 1.0, theta will be set
<p>Note that <i>isEmpty()</i> does not always mean that theta is 1.0 because if <i>p</i> &lt; 1.0, theta will be set
equal to <i>p</i> during construction.
Also, a cache of zero values (<i>getRetainedEntries(true) = 0</i>) does not mean that the sketch is <i>Empty</i> since
set intersection or difference operations can result in a sketch with zero values.
@@ -216,7 +217,7 @@ <h3><a name="seed">Seed</a></h3>
of sketches that were generated with different seeds a short, 16-bit,
<a href="#seedHash">Seed Hash</a> is stored with the sketch image.
When heapifying or wrapping an UpdateSketch image, which can be either a byte array or a Memory object,
the user must provide the original seed either directly or indirectly by assuming the <i>DEFAULT_UPDATE_SEED</i>.
the user must provide the original seed either directly or indirectly by assuming the <a href="#defaultUpdateSeed">DEFAULT_UPDATE_SEED</a>.
The provided seed will be hashed and validated against the internal short Seed Hash and an error will be thrown if the seed hashes do not match.
The Set Operations classes, Union, Intersection and AnotB also require the user to provide the seed either directly or indirectly.
<p>An internal check will be made to make sure that the provided seed does not hash to a 16-bit value of zero.
@@ -225,7 +226,7 @@ <h3><a name="seed">Seed</a></h3>
See also <a href="#defaultUpdateSeed">Default Update Seed</a>.

<h3><a name="seedHash">Seed Hash</a></h3>
For Theta Sketches, a 16-bit hash of the <a href="#seed">Update Hash Seed</a> used internally to validate
For Theta and Tuple Sketches, a 16-bit hash of the <a href="#seed">Update Hash Seed</a> used internally to validate
(1) that two sketches undergoing set operations were, in fact, created using matching <a href="#seed">Update Hash Seeds</a>;
or (2) that when deserializing or wrapping a sketch image that the caller has the correct seed.

0 comments on commit 43f443a

Please sign in to comment.