You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by tl...@apache.org on 2021/10/13 12:52:55 UTC
[ignite] branch master updated: IGNITE-12846 Docs: add description
for a few packages (#9486)
This is an automated email from the ASF dual-hosted git repository.
tledkov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 8a4e14e IGNITE-12846 Docs: add description for a few packages (#9486)
8a4e14e is described below
commit 8a4e14ea2b2981496c20d07f9b03d51c0d8f3639
Author: ygerzhedovich <41...@users.noreply.github.com>
AuthorDate: Wed Oct 13 15:52:28 2021 +0300
IGNITE-12846 Docs: add description for a few packages (#9486)
---
.../spi/discovery/isolated/package-info.java | 23 ++++++++++++++++++++++
.../ml/composition/bagging/package-info.java | 22 +++++++++++++++++++++
.../ignite/ml/inference/json/package-info.java | 22 +++++++++++++++++++++
.../ignite/ml/knn/utils/indices/package-info.java | 22 +++++++++++++++++++++
.../apache/ignite/ml/util/plugin/package-info.java | 22 +++++++++++++++++++++
5 files changed, 111 insertions(+)
diff --git a/modules/core/src/main/java/org/apache/ignite/spi/discovery/isolated/package-info.java b/modules/core/src/main/java/org/apache/ignite/spi/discovery/isolated/package-info.java
new file mode 100644
index 0000000..9a532e2
--- /dev/null
+++ b/modules/core/src/main/java/org/apache/ignite/spi/discovery/isolated/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+/**
+ * <!-- Package description. -->
+ * Contains implementation of special "isolated" mode for single-node cluster.
+ */
+
+package org.apache.ignite.spi.discovery.isolated;
diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/composition/bagging/package-info.java b/modules/ml/src/main/java/org/apache/ignite/ml/composition/bagging/package-info.java
new file mode 100644
index 0000000..88c8f16
--- /dev/null
+++ b/modules/ml/src/main/java/org/apache/ignite/ml/composition/bagging/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+
+/**
+ * <!-- Package description. -->
+ * Contains bootstrap aggregation (bagging) trainer allowing to combine some other trainers and return a bagged version of them.
+ */
+package org.apache.ignite.ml.composition.bagging;
diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/inference/json/package-info.java b/modules/ml/src/main/java/org/apache/ignite/ml/inference/json/package-info.java
new file mode 100644
index 0000000..c20e89d
--- /dev/null
+++ b/modules/ml/src/main/java/org/apache/ignite/ml/inference/json/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+
+/**
+ * <!-- Package description. -->
+ * Root package for JSON export/import support for all models.
+ */
+package org.apache.ignite.ml.inference.json;
diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/knn/utils/indices/package-info.java b/modules/ml/src/main/java/org/apache/ignite/ml/knn/utils/indices/package-info.java
new file mode 100644
index 0000000..0024ac1
--- /dev/null
+++ b/modules/ml/src/main/java/org/apache/ignite/ml/knn/utils/indices/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+
+/**
+ * <!-- Package description. -->
+ * Contains utils functionality for indices in kNN algorithms.
+ */
+package org.apache.ignite.ml.knn.utils.indices;
diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/util/plugin/package-info.java b/modules/ml/src/main/java/org/apache/ignite/ml/util/plugin/package-info.java
new file mode 100644
index 0000000..61f09db
--- /dev/null
+++ b/modules/ml/src/main/java/org/apache/ignite/ml/util/plugin/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+
+/**
+ * <!-- Package description. -->
+ * Contains Ignite plugins system integration classes.
+ */
+package org.apache.ignite.ml.util.plugin;