MXNET-650 [Perl] Gluon ModelZoo, Gluon examples

perl-package/AI-MXNet-Gluon-Contrib/Changes

@@ -0,0 +1,5 @@
+Revision history for Perl extension AI::MXNet::Gluon::Contrib
+
+1.3     Tue Jul 10 21:19:13 PDT 2018
+        - Initial release
+

perl-package/AI-MXNet-Gluon-Contrib/MANIFEST

@@ -0,0 +1,9 @@
+Changes
+lib/AI/MXNet/Gluon/Contrib.pm
+lib/AI/MXNet/Gluon/Contrib/NN/BasicLayers.pm
+Makefile.PL
+MANIFEST
+META.json
+META.yml
+README
+t/AI-MXNet-Gluon-Contrib.t

perl-package/AI-MXNet-Gluon-Contrib/META.json

@@ -0,0 +1,42 @@
+{
+   "abstract" : "Perl interface to MXNet Gluon Contrib",
+   "author" : [
+      "Sergey Kolychev <[email protected]>"
+   ],
+   "dynamic_config" : 0,
+   "generated_by" : "ExtUtils::MakeMaker version 7.24, CPAN::Meta::Converter version 2.143240",
+   "license" : [
+      "apache_2_0"
+   ],
+   "meta-spec" : {
+      "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
+      "version" : "2"
+   },
+   "name" : "AI-MXNet-Gluon-Contrib",
+   "no_index" : {
+      "directory" : [
+         "t",
+         "inc"
+      ]
+   },
+   "prereqs" : {
+      "build" : {
+         "requires" : {}
+      },
+      "configure" : {
+         "requires" : {
+            "ExtUtils::MakeMaker" : "6.30"
+         }
+      },
+      "runtime" : {
+         "requires" : {
+            "AI::MXNet" : "1.31",
+         }
+      },
+      "test" : {
+         "requires" : {}
+      }
+   },
+   "release_status" : "stable",
+   "version" : "1.3"
+}

perl-package/AI-MXNet-Gluon-Contrib/META.yml

@@ -0,0 +1,21 @@
+---
+abstract: 'Perl interface to MXNet Gluon Contrib'
+author:
+  - 'Sergey Kolychev <[email protected]>'
+build_requires: {}
+configure_requires:
+  ExtUtils::MakeMaker: '6.30'
+dynamic_config: 0
+generated_by: 'ExtUtils::MakeMaker version 7.24, CPAN::Meta::Converter version 2.143240'
+license: apache
+meta-spec:
+  url: http://module-build.sourceforge.net/META-spec-v1.4.html
+  version: '1.4'
+name: AI-MXNet-Gluon-Contrib
+no_index:
+  directory:
+    - t
+    - inc
+requires:
+  AI::MXNet: '1.31'
+version: '1.3'

perl-package/AI-MXNet-Gluon-Contrib/Makefile.PL

@@ -0,0 +1,63 @@
+# 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.
+
+use strict;
+use warnings;
+
+use 5.014000;
+
+use ExtUtils::MakeMaker 6.30;
+
+
+
+my %WriteMakefileArgs = (
+  "ABSTRACT" => "Perl interface to MXNet Gluon Contrib",
+  "AUTHOR" => "Sergey Kolychev <sergeykolychev.github\@gmail.com>",
+  "BUILD_REQUIRES" => {},
+  "CONFIGURE_REQUIRES" => {
+    "ExtUtils::MakeMaker" => "6.30"
+  },
+  "DISTNAME" => "AI-MXNet-Gluon-Contrib",
+  "EXE_FILES" => [],
+  "LICENSE" => "apache_2_0",
+  "NAME" => "AI::MXNet::Gluon::Contrib",
+  "PREREQ_PM" => {
+    "AI::MXNet" => "1.31",
+  },
+  "TEST_REQUIRES" => {},
+  "VERSION" => "1.3",
+  "test" => {
+    "TESTS" => "t/*.t"
+  }
+);
+
+
+my %FallbackPrereqs = (
+  "AI::MXNet" => "1.31"
+);
+
+
+unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) {
+  delete $WriteMakefileArgs{TEST_REQUIRES};
+  delete $WriteMakefileArgs{BUILD_REQUIRES};
+  $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs;
+}
+
+delete $WriteMakefileArgs{CONFIGURE_REQUIRES}
+  unless eval { ExtUtils::MakeMaker->VERSION(6.52) };
+
+WriteMakefile(%WriteMakefileArgs);

perl-package/AI-MXNet-Gluon-Contrib/README

@@ -0,0 +1,7 @@
+This archive contains the distribution AI-MXNet-Gluon-Contrib,
+version 1.3:
+
+  Perl interface to MXNet Gluon Contib modules, a collection of supplemental Gluon blocks.
+
+This library is licensed under Apache 2.0 license https://www.apache.org/licenses/LICENSE-2.0
+

perl-package/AI-MXNet-Gluon-Contrib/lib/AI/MXNet/Gluon/Contrib.pm

@@ -0,0 +1,24 @@
+# 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.
+
+use strict;
+use warnings;
+use AI::MXNet;
+use AI::MXNet::Gluon::Contrib::NN::BasicLayers;
+our $VERSION = '1.3';
+
+1;

perl-package/AI-MXNet-Gluon-Contrib/lib/AI/MXNet/Gluon/Contrib/NN/BasicLayers.pm

@@ -0,0 +1,201 @@
+# 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.
+
+use strict;
+use warnings;
+use AI::MXNet::Function::Parameters;
+package AI::MXNet::Gluon::NN::Concurrent;
+use AI::MXNet::Gluon::Mouse;
+extends 'AI::MXNet::Gluon::NN::Sequential';
+
+=head1 NAME
+
+    AI::MXNet::Gluon::NN::Concurrent - Lays Blocks concurrently.
+=cut
+
+=head1 DESCRIPTION
+
+    Lays Blocks concurrently.
+
+    This block feeds its input to all children blocks, and
+    produces the output by concatenating all the children blocks' outputs
+    on the specified axis.
+
+    Example:
+
+        $net = nn->Concurrent();
+        # use net's name_scope to give children blocks appropriate names.
+        $net->name_scope(sub {
+            $net->add(nn->Dense(10, activation=>'relu'));
+            $net->add(nn->Dense(20));
+            $net->add(nn->Identity());
+        });
+
+    Parameters
+    ----------
+    axis : int, default -1
+        The axis on which to concatenate the outputs.
+=cut
+has 'axis' => (is => 'rw', isa => 'Int', default => -1);
+method python_constructor_arguments() { ['axis'] }
+
+method forward(GluonInput $x)
+{
+    return AI::MXNet::NDArray->concat((map { $_->($x) } $self->_children->values), dim=>$self->axis);
+}
+
+__PACKAGE__->register('AI::MXNet::Gluon::NN');
+
+package AI::MXNet::Gluon::NN::HybridConcurrent;
+use AI::MXNet::Gluon::Mouse;
+extends 'AI::MXNet::Gluon::NN::HybridSequential';
+
+=head1 NAME
+
+    AI::MXNet::Gluon::NN::HybridConcurrent - Lays HubridBlocks concurrently.
+=cut
+
+=head1 DESCRIPTION
+
+    Lays HybridBlocks concurrently.
+
+    This block feeds its input to all children blocks, and
+    produces the output by concatenating all the children blocks' outputs
+    on the specified axis.
+
+    Example:
+
+        $net = nn->HybridConcurrent();
+        # use net's name_scope to give children blocks appropriate names.
+        $net->name_scope(sub {
+            $net->add(nn->Dense(10, activation=>'relu'));
+            $net->add(nn->Dense(20));
+            $net->add(nn->Identity());
+        });
+
+    Parameters
+    ----------
+    axis : int, default -1
+        The axis on which to concatenate the outputs.
+=cut
+has 'axis' => (is => 'rw', isa => 'Int', default => -1);
+method python_constructor_arguments() { ['axis'] }
+
+method hybrid_forward(GluonClass $F, GluonInput $x)
+{
+    return $F->concat((map { $_->($x) } $self->_children->values), dim=>$self->axis);
+}
+
+__PACKAGE__->register('AI::MXNet::Gluon::NN');
+
+package AI::MXNet::Gluon::NN::Identity;
+use AI::MXNet::Gluon::Mouse;
+extends 'AI::MXNet::Gluon::HybridBlock';
+
+=head1 NAME
+
+    AI::MXNet::Gluon::NN::Identity - Block that passes through the input directly.
+=cut
+
+=head1 DESCRIPTION
+
+    Block that passes through the input directly.
+
+    This block can be used in conjunction with HybridConcurrent
+    block for residual connection.
+
+    Example:
+
+        $net = nn->HybridConcurrent();
+        # use net's name_scope to give child Blocks appropriate names.
+        $net->name_scope(sub {
+            $net->add(nn->Dense(10, activation=>'relu'));
+            $net->add(nn->Dense(20));
+            $net->add(nn->Identity());
+        });
+=cut
+
+method hybrid_forward(GluonClass $F, GluonInput $x)
+{
+    return $x;
+}
+
+__PACKAGE__->register('AI::MXNet::Gluon::NN');
+
+package AI::MXNet::Gluon::NN::SparseEmbedding;
+use AI::MXNet::Gluon::Mouse;
+extends 'AI::MXNet::Gluon::Block';
+
+=head1 NAME
+
+    AI::MXNet::Gluon::NN::SparseEmbedding - Turns non-negative integers (indexes/tokens) into dense vectors.
+=cut
+
+=head1 DESCRIPTION
+
+    Turns non-negative integers (indexes/tokens) into dense vectors
+    of fixed size. eg. [4, 20] -> [[0.25, 0.1], [0.6, -0.2]]
+
+    This SparseBlock is designed for distributed training with extremely large
+    input dimension. Both weight and gradient w.r.t. weight are AI::MXNet::NDArray::RowSparse.
+
+    Parameters
+    ----------
+    input_dim : int
+        Size of the vocabulary, i.e. maximum integer index + 1.
+    output_dim : int
+        Dimension of the dense embedding.
+    dtype : Dtype, default 'float32'
+        Data type of output embeddings.
+    weight_initializer : Initializer
+        Initializer for the embeddings matrix.
+=cut
+
+has 'input_dim'          => (is => 'ro', isa => 'Int', required => 1);
+has 'output_dim'         => (is => 'ro', isa => 'Int', required => 1);
+has 'dtype'              => (is => 'ro', isa => 'Dtype', default => 'float32');
+has 'weight_initializer' => (is => 'ro', isa => 'Maybe[Initializer]');
+method python_constructor_arguments() { [qw/input_dim output_dim dtype weight_initializer/] }
+
+sub BUILD
+{
+    my $self = shift;
+    $self->_kwargs({
+        input_dim => $self->input_dim, 
+        output_dim => $self->output_dim,
+        dtype => $self->dtype,
+        sparse_grad => 1
+    });
+    $self->weight($self->params->get('weight', shape=>[$self->input_dim, $self->output_dim],
+                                      init=>$self->weight_initializer, dtype=>$self->dtype,
+                                      grad_stype=>'row_sparse', stype=>'row_sparse'));
+}
+
+method forward(GluonInput $x)
+{
+    my $weight = $self->weight->row_sparse_data($x);
+    return AI::MXNet::NDArray->Embedding($x, $weight, { name=>'fwd', %{ $self->_kwargs } });
+}
+
+use overload '""' => sub {
+    my $self = shift;
+    $self->_class_name.'('.$self->input_dim.' -> '.$self->input_dim.', '.$self->dtype.')';
+};
+
+__PACKAGE__->register('AI::MXNet::Gluon::NN');
+
+1;