hope that everything goes well

- update release notes
- remove Include
- remove NewDisposeScope and rename InnerNewDisposeScope
- reorder members in DisposeScopeManager
- make the paramter of RegisterOnCurrentDisposeScope to be torch.Tensor only

Author: yueyinqiu

RELEASENOTES.md

@@ -8,11 +8,14 @@ __Breaking Changes__:
 
 - `torchvision.dataset.MNIST` will try more mirrors.
     - The thrown exception might be changed when it fails to download `MNIST`, `FashionMNIST` or `KMNIST`.
+- `ObjectDisposedException` will now be thrown when trying to use the disposed dispose scopes.
+    - The constructor of dispose scopes is no longer `public`. Use `torch.NewDisposeScope` instead.
 
 __API Changes__:
 
 - #1291 `Tensor.grad()` and `Tensor.set_grad()` have been replaced by a new property `Tensor.grad`.
     - A potential memory leak caused by `set_grad` has been resolved.
+- `Include` method of dispose scopes has been removed. Use `Attach` instead.
 
 __Bug Fixes__:
 

src/TorchSharp/DataLoader.cs

@@ -277,7 +277,7 @@ private bool MoveNextValue()
                 public bool MoveNext()
                 {
                     DisposeCurrent();
-                    using (var scope = DisposeScopeManager.NewDisposeScope()) {
+                    using (var scope = torch.NewDisposeScope()) {
                         if (!MoveNextValue()) return false;
 
                         var tensorIndexList = new List<long> { currentVal };
@@ -300,7 +300,7 @@ public bool MoveNext()
                         foreach (var task in tasks)
                             task.Wait();
 
-                        using (var collate_scope = DisposeScopeManager.NewDisposeScope()) {
+                        using (var collate_scope = torch.NewDisposeScope()) {
                             Current = collate_fn(items, device);
                             currentDisposables = collate_scope.DisposablesView.ToList();
                             collate_scope.Detach(currentDisposables);

src/TorchSharp/DisposeScope.cs

@@ -56,21 +56,6 @@ public int DisposablesCount {
             }
         }
 
-        /// <summary>
-        /// Includes a disposable in the scope - for tensors this is done automatically once the scope has been
-        /// created. Use this method to add additional disposables that should be disposed, but you typically
-        /// don't need to call this method.
-        /// </summary>
-        /// <param name="disposable">The disposable to keep in the scope</param>
-        /// <returns></returns>
-        public T Include<T>(T disposable) where T : IDisposable
-        {
-            if (this._disposeScopeManager is null)
-                throw new ObjectDisposedException("The dispose scope has been disposed.");
-            Disposables.Add(disposable);
-            return disposable;
-        }
-
         /// <summary>
         /// Excludes a set of tensors/disposables from the current dispose scope, and moves it up to the outer
         /// dispose scope, if one exists. See overloaded methods. If you wish to exclude a tensor from all sccopes,

src/TorchSharp/DisposeScopeManager.cs

@@ -1,8 +1,6 @@
 // Copyright (c) .NET Foundation and Contributors.  All Rights Reserved.  See LICENSE in the project root for license information.
 
 using System;
-using System.Collections.Generic;
-using System.Diagnostics;
 
 #nullable enable
 namespace TorchSharp
@@ -15,30 +13,23 @@ namespace TorchSharp
     public class DisposeScopeManager
     {
         [ThreadStatic] private static DisposeScopeManager? _threadSingleton;
-        internal ThreadDisposeScopeStatistics StatisticsInstance { get; } = new ThreadDisposeScopeStatistics();
-
         internal static DisposeScopeManager ThreadSingleton => (_threadSingleton ??= new DisposeScopeManager());
-        internal DisposeScope? CurrentDisposeScope { get; set; } = null;
 
-        public static ThreadDisposeScopeStatistics Statistics => ThreadSingleton.StatisticsInstance;
+        internal ThreadDisposeScopeStatistics StatisticsInstance { get; } = new ThreadDisposeScopeStatistics();
+        internal DisposeScope? CurrentDisposeScope { get; private set; } = null;
 
-        internal DisposeScope? RegisterOnCurrentDisposeScope(IDisposable disposable)
+        internal DisposeScope? RegisterOnCurrentDisposeScope(torch.Tensor tensor)
         {
             if (this.CurrentDisposeScope is null) {
                 StatisticsInstance.CreatedOutsideScopeCount++;
                 return null;
             }
 
             StatisticsInstance.CreatedInScopeCount++;
-            this.CurrentDisposeScope.Include(disposable);
+            this.CurrentDisposeScope.Disposables.Add(tensor);
             return CurrentDisposeScope;
         }
 
-        internal static DisposeScope NewDisposeScope()
-        {
-            return ThreadSingleton.InnerNewDisposeScope();
-        }
-
         internal void RemoveDisposeScope(DisposeScope disposeScope)
         {
             var scope = this.CurrentDisposeScope;
@@ -64,10 +55,12 @@ internal void RemoveDisposeScope(DisposeScope disposeScope)
             }
         }
 
-        private DisposeScope InnerNewDisposeScope()
+        internal DisposeScope NewDisposeScope()
         {
             this.CurrentDisposeScope = new DisposeScope(this);
             return this.CurrentDisposeScope;
         }
+
+        public static ThreadDisposeScopeStatistics Statistics => ThreadSingleton.StatisticsInstance;
     }
 }

src/TorchSharp/Tensor/Tensor.cs

@@ -7374,7 +7374,8 @@ public static long max_int_value(ScalarType type)
         /// Creates a new dispose scope for the current thread. Any tensor created within the dispose scope will
         /// be automatically disposed once the dispose scope is disposed.
         /// </summary>
-        public static DisposeScope NewDisposeScope() => DisposeScopeManager.NewDisposeScope();
+        public static DisposeScope NewDisposeScope() =>
+            DisposeScopeManager.ThreadSingleton.NewDisposeScope();
 
         /// <summary>
         /// Creates a new dispose scope for the current thread, wrapping an expression.