Move input array checks out of autograd example (#231)

* Add missing summary of autograd to examples README
* Move cleanup subroutine and checks that input arrays aren't changed by arithmetic
* Call cleanup if assertion fails in operator overload tests
* Call cleanup if assertion fails in constructor tests

Author: jwallwork23

examples/6_Autograd/autograd.f90

@@ -67,28 +67,9 @@ program example
     stop 999
   end if
 
-  ! Check first input array is unchanged by the arithmetic operations
-  expected(:,1) = [2.0_wp, 3.0_wp]
-  test_pass = assert_allclose(in_data1, expected, test_name="torch_tensor_to_array", rtol=1e-5)
-  if (.not. test_pass) then
-    call clean_up()
-    print *, "Error :: in_data1 was changed during arithmetic operations"
-    stop 999
-  end if
-
-  ! Check second input array is unchanged by the arithmetic operations
-  expected(:,1) = [6.0_wp, 4.0_wp]
-  test_pass = assert_allclose(in_data2, expected, test_name="torch_tensor_to_array", rtol=1e-5)
-  if (.not. test_pass) then
-    call clean_up()
-    print *, "Error :: in_data2 was changed during arithmetic operations"
-    stop 999
-  end if
-
   ! Back-propagation
   ! TODO: Requires API extension
 
-  ! Cleanup
   call clean_up()
   write (*,*) "Autograd example ran successfully"
 

examples/README.md

@@ -23,6 +23,11 @@ This directory contains a number of examples of how to use the library:
       This example demonstrates how to structure code in these cases, separating reading
       in of a net from the call to the forward pass.
 
+6. Autograd
+    - **This example is currently under development.** Eventually, it will
+      demonstrate automatic differentation in FTorch by leveraging PyTorch's
+      Autograd module.
+
 To run select examples as integration tests, use the CMake argument
 ```
 -DCMAKE_BUILD_TESTS=TRUE

src/test/unit/test_constructors.pf

@@ -81,12 +81,21 @@ subroutine test_torch_tensor_zeros()
   ! Check that the tensor values are all zero
   expected(:,:) = 0.0
   test_pass = assert_allclose(out_data, expected, test_name="test_torch_tensor_zeros")
-  @assertTrue(test_pass)
-  @assertEqual(shape(out_data), shape(expected))
+  if (.not. test_pass) then
+    call clean_up()
+    print *, "Error :: incorrect output from torch_tensor_zeros subroutine"
+    stop 999
+  end if
 
-  ! Cleanup
-  nullify(out_data)
-  call torch_tensor_delete(tensor)
+  call clean_up()
+
+  contains
+
+    ! Subroutine for freeing memory and nullifying pointers used in the unit test
+    subroutine clean_up()
+      nullify(out_data)
+      call torch_tensor_delete(tensor)
+    end subroutine clean_up
 
 end subroutine test_torch_tensor_zeros
 
@@ -132,12 +141,21 @@ subroutine test_torch_tensor_ones()
   ! Check that the tensor values are all one
   expected(:,:) = 1.0
   test_pass = assert_allclose(out_data, expected, test_name="test_torch_tensor_ones")
-  @assertTrue(test_pass)
-  @assertEqual(shape(out_data), shape(expected))
+  if (.not. test_pass) then
+    call clean_up()
+    print *, "Error :: incorrect output from torch_tensor_ones subroutine"
+    stop 999
+  end if
 
-  ! Cleanup
-  nullify(out_data)
-  call torch_tensor_delete(tensor)
+  call clean_up()
+
+  contains
+
+    ! Subroutine for freeing memory and nullifying pointers used in the unit test
+    subroutine clean_up()
+      nullify(out_data)
+      call torch_tensor_delete(tensor)
+    end subroutine clean_up
 
 end subroutine test_torch_tensor_ones
 
@@ -184,12 +202,21 @@ subroutine test_torch_from_array_1d()
   ! Compare the data in the tensor to the input data
   expected(:) = in_data
   test_pass = assert_allclose(out_data, expected, test_name="test_torch_tensor_from_array")
-  @assertTrue(test_pass)
-  @assertEqual(shape(out_data), shape(expected))
+  if (.not. test_pass) then
+    call clean_up()
+    print *, "Error :: incorrect output from torch_tensor_from_array subroutine"
+    stop 999
+  end if
 
-  ! Cleanup
-  nullify(out_data)
-  call torch_tensor_delete(tensor)
+  call clean_up()
+
+  contains
+
+    ! Subroutine for freeing memory and nullifying pointers used in the unit test
+    subroutine clean_up()
+      nullify(out_data)
+      call torch_tensor_delete(tensor)
+    end subroutine clean_up
 
 end subroutine test_torch_from_array_1d
 
@@ -236,12 +263,21 @@ subroutine test_torch_from_array_2d()
   ! Compare the data in the tensor to the input data
   expected(:,:) = in_data
   test_pass = assert_allclose(out_data, expected, test_name="test_torch_tensor_from_array")
-  @assertTrue(test_pass)
-  @assertEqual(shape(out_data), shape(expected))
+  if (.not. test_pass) then
+    call clean_up()
+    print *, "Error :: incorrect output from torch_tensor_from_array subroutine"
+    stop 999
+  end if
 
-  ! Cleanup
-  nullify(out_data)
-  call torch_tensor_delete(tensor)
+  call clean_up()
+
+  contains
+
+    ! Subroutine for freeing memory and nullifying pointers used in the unit test
+    subroutine clean_up()
+      nullify(out_data)
+      call torch_tensor_delete(tensor)
+    end subroutine clean_up
 
 end subroutine test_torch_from_array_2d
 
@@ -286,12 +322,21 @@ subroutine test_torch_from_array_3d()
   ! Compare the data in the tensor to the input data
   expected(:,:,:) = in_data
   test_pass = assert_allclose(out_data, expected, test_name="test_torch_tensor_from_array")
-  @assertTrue(test_pass)
-  @assertEqual(shape(out_data), shape(expected))
+  if (.not. test_pass) then
+    call clean_up()
+    print *, "Error :: incorrect output from torch_tensor_from_array subroutine"
+    stop 999
+  end if
 
-  ! Cleanup
-  nullify(out_data)
-  call torch_tensor_delete(tensor)
+  call clean_up()
+
+  contains
+
+    ! Subroutine for freeing memory and nullifying pointers used in the unit test
+    subroutine clean_up()
+      nullify(out_data)
+      call torch_tensor_delete(tensor)
+    end subroutine clean_up
 
 end subroutine test_torch_from_array_3d
 
@@ -340,11 +385,20 @@ subroutine test_torch_from_blob()
   ! Compare the data in the tensor to the input data 
   expected(:,:) = in_data
   test_pass = assert_allclose(out_data, expected, test_name="test_torch_tensor_from_blob")
-  @assertTrue(test_pass)
-  @assertEqual(shape(out_data), shape(expected))
+  if (.not. test_pass) then
+    call clean_up()
+    print *, "Error :: incorrect output from torch_tensor_from_array subroutine"
+    stop 999
+  end if
 
-  ! Cleanup
-  nullify(out_data)
-  call torch_tensor_delete(tensor)
+  call clean_up()
+
+  contains
+
+    ! Subroutine for freeing memory and nullifying pointers used in the unit test
+    subroutine clean_up()
+      nullify(out_data)
+      call torch_tensor_delete(tensor)
+    end subroutine clean_up
 
 end subroutine test_torch_from_blob