diff --git a/Makefile b/Makefile index da764ed82..1a1aa3469 100644 --- a/Makefile +++ b/Makefile @@ -311,11 +311,11 @@ todo: .PHONY: supported_functions # Update docs with supported functions supported_functions: - poetry run python script/doc_utils/gen_supported_ufuncs.py docs/user/tutorial/NUMPY_SUPPORT.md + poetry run python script/doc_utils/gen_supported_ufuncs.py docs/user/howto/NUMPY_SUPPORT.md .PHONY: check_supported_functions # Check supported functions (for the doc) check_supported_functions: - poetry run python script/doc_utils/gen_supported_ufuncs.py docs/user/tutorial/NUMPY_SUPPORT.md --check + poetry run python script/doc_utils/gen_supported_ufuncs.py docs/user/howto/NUMPY_SUPPORT.md --check .PHONY: licences # Generate the list of licenses of dependencies licences: diff --git a/docs/user/tutorial/NUMPY_SUPPORT.md b/docs/user/howto/NUMPY_SUPPORT.md similarity index 94% rename from docs/user/tutorial/NUMPY_SUPPORT.md rename to docs/user/howto/NUMPY_SUPPORT.md index 18cd8f9ec..769804205 100644 --- a/docs/user/tutorial/NUMPY_SUPPORT.md +++ b/docs/user/howto/NUMPY_SUPPORT.md @@ -119,7 +119,7 @@ The framework also gives support for: - true div, i.e., `x / y`: if one of `x` or `y` is a constant - floor div, i.e., `x // y`: if one of `x` or `y` is a constant -There is support for astype as well, e.g. `x.astype(numpy.int32)`. This allows to control which data type to use for computations. In the context of FHE going back to integers may allow to fuse floating point operations together, see [this tutorial](./WORKING_WITH_FLOATING_POINTS.md) to see how to work with floating point values. +There is support for astype as well, e.g. `x.astype(numpy.int32)`. This allows to control which data type to use for computations. In the context of FHE going back to integers may allow to fuse floating point operations together, see [this tutorial](../tutorial/WORKING_WITH_FLOATING_POINTS.md) to see how to work with floating point values. ```{warning} FIXME(Umut): speak about `shape` diff --git a/docs/user/index.rst b/docs/user/index.rst index ac8009b1a..bf9181fb4 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -17,7 +17,6 @@ Getting Started tutorial/COMPILING_TORCH_MODEL.md tutorial/TABLE_LOOKUP.md tutorial/WORKING_WITH_FLOATING_POINTS.md - tutorial/NUMPY_SUPPORT.md tutorial/INDEXING.md tutorial/MACHINE_LEARNING_TOOLS.md tutorial/COMPILATION_ARTIFACTS.md @@ -26,6 +25,7 @@ Getting Started :maxdepth: 1 :caption: How to + howto/NUMPY_SUPPORT.md howto/PRINTING_AND_DRAWING.md howto/USE_QUANTIZATION.md howto/REDUCE_NEEDED_PRECISION.md diff --git a/docs/user/tutorial/WORKING_WITH_FLOATING_POINTS.md b/docs/user/tutorial/WORKING_WITH_FLOATING_POINTS.md index 3ca0501a7..e7eaf3ea4 100644 --- a/docs/user/tutorial/WORKING_WITH_FLOATING_POINTS.md +++ b/docs/user/tutorial/WORKING_WITH_FLOATING_POINTS.md @@ -26,7 +26,7 @@ assert circuit.run(60) == f(60) print("All good!") ``` -One can look to [numpy supported functions](NUMPY_SUPPORT.md) for information about possible float operations. +One can look to [numpy supported functions](../howto/NUMPY_SUPPORT.md) for information about possible float operations. ## Limitations