PackedSequence internal tensors manages internally to optimize scope management

Author: mvphelps

src/TorchSharp/NN/Utils/PackedSequence.cs

@@ -86,10 +86,10 @@ protected override bool ReleaseHandle()
                         internal PackedSequence(HType handle)
                         {
                             this.handle = handle;
-                            this.data = new Tensor(THSNN_PackedSequence_data(handle));
-                            this.batch_sizes = new Tensor(THSNN_PackedSequence_batch_sizes(handle));
-                            this.sorted_indices = new Tensor(THSNN_PackedSequence_sorted_indices(handle));
-                            this.unsorted_indices = new Tensor(THSNN_PackedSequence_unsorted_indices(handle));
+                            this.data = new Tensor(THSNN_PackedSequence_data(handle)).DetachFromDisposeScope();
+                            this.batch_sizes = new Tensor(THSNN_PackedSequence_batch_sizes(handle)).DetachFromDisposeScope();
+                            this.sorted_indices = new Tensor(THSNN_PackedSequence_sorted_indices(handle)).DetachFromDisposeScope();
+                            this.unsorted_indices = new Tensor(THSNN_PackedSequence_unsorted_indices(handle)).DetachFromDisposeScope();
                             OwningDisposeScope = DisposeScopeManager.ThreadSingleton.RegisterOnCurrentDisposeScope(this);
                         }
 
@@ -119,10 +119,6 @@ public void Dispose()
                         /// <returns>The same PackedSequence that the method was called on</returns>
                         public PackedSequence MoveToOuterDisposeScope()
                         {
-                            OwningDisposeScope?.MoveToOuter(this.data);
-                            OwningDisposeScope?.MoveToOuter(this.batch_sizes);
-                            OwningDisposeScope?.MoveToOuter(this.sorted_indices);
-                            OwningDisposeScope?.MoveToOuter(this.unsorted_indices);
                             OwningDisposeScope?.MoveToOuter(this);
                             return this;
                         }
@@ -133,10 +129,6 @@ public PackedSequence MoveToOuterDisposeScope()
                         /// <returns>The same PackedSequence that the method was called on</returns>
                         public PackedSequence DetachFromDisposeScope()
                         {
-                            OwningDisposeScope?.Detach(this.data);
-                            OwningDisposeScope?.Detach(this.batch_sizes);
-                            OwningDisposeScope?.Detach(this.sorted_indices);
-                            OwningDisposeScope?.Detach(this.unsorted_indices);
                             OwningDisposeScope?.Detach(this);
                             return this;
                         }
@@ -149,17 +141,9 @@ public PackedSequence MoveToOtherDisposeScope(PackedSequence other)
                         public PackedSequence MoveToOtherDisposeScope(DisposeScope other)
                         {
                             if (OwningDisposeScope == null && other != null) {
-                                other.Attach(this.data);
-                                other.Attach(this.batch_sizes);
-                                other.Attach(this.sorted_indices);
-                                other.Attach(this.unsorted_indices);
                                 other.Attach(this);
                             }
                             else {
-                                OwningDisposeScope?.MoveToOther(other, this.data);
-                                OwningDisposeScope?.MoveToOther(other, this.batch_sizes);
-                                OwningDisposeScope?.MoveToOther(other, this.sorted_indices);
-                                OwningDisposeScope?.MoveToOther(other, this.unsorted_indices);
                                 OwningDisposeScope?.MoveToOther(other, this);
                             }
                             return this;

test/TorchSharpTest/TestDisposeScopesPackedSequence.cs

@@ -39,7 +39,7 @@ public void DisposablesValidityWhenNotSorted()
         var sequences = CreateTestSequences();
         using var scope = torch.NewDisposeScope();
         var packed = torch.nn.utils.rnn.pack_sequence(sequences, enforce_sorted: false);
-        Assert.Equal(5, scope.DisposablesCount);
+        Assert.Equal(1, scope.DisposablesCount);
         AssertPackedSequenceValid(packed);
     }
 
@@ -49,7 +49,7 @@ public void DisposablesValidityWhenSorted()
         var sequences = CreateTestSequences();
         using var scope = torch.NewDisposeScope();
         var packed = torch.nn.utils.rnn.pack_sequence(sequences, enforce_sorted: true);
-        Assert.Equal(5, scope.DisposablesCount);
+        Assert.Equal(1, scope.DisposablesCount);
         Assert.False(GetPackedSequenceIsInvalid(packed));
         Assert.False(packed.batch_sizes.IsInvalid);
         Assert.False(packed.data.IsInvalid);
@@ -70,17 +70,17 @@ public void DisposeScopeStatistics()
         AssertStatCounts(0, 7, 0, 0, 0);
 
         var inScope = torch.nn.utils.rnn.pack_sequence(sequences, enforce_sorted: true);
-        AssertStatCounts(5, 7, 0, 0, 5);
+        AssertStatCounts(5, 7, 4, 0, 1);
 
         scope.Attach(outOfScope);
-        //Possible subtle bug. When attaching an object that isn't owned by any scope, the count goes negative.
-        AssertStatCounts( 5, 7, -1, 0, 6);
+        //Possible subtle bug. When attaching an object that isn't owned by any scope, the count subtracts.
+        AssertStatCounts( 5, 7, 3, 0, 2);
 
         scope.Detach(inScope);
-        AssertStatCounts( 5, 7, 0, 0, 5);
+        AssertStatCounts( 5, 7, 4, 0, 1);
 
         outOfScope.Dispose();
-        AssertStatCounts( 5, 7, 0, 5, 0);
+        AssertStatCounts( 5, 7, 4, 5, -4);
 
     }