From 43fe3cd62044f2d5d1d99209467b412dd74883c8 Mon Sep 17 00:00:00 2001 From: Marcello Seri Date: Sun, 4 Oct 2020 11:29:46 +0200 Subject: [PATCH] Fix odoc heading level errors Uniformly across all modules Signed-off-by: Marcello Seri --- src/base/algodiff/owl_algodiff_core_sig.ml | 4 +- src/base/algodiff/owl_algodiff_generic_sig.ml | 2 +- src/base/algodiff/owl_algodiff_ops_sig.ml | 12 +-- src/base/compute/owl_computation_graph_sig.ml | 4 +- .../compute/owl_computation_operator_sig.ml | 4 +- .../compute/owl_computation_optimiser_sig.ml | 2 +- src/base/compute/owl_computation_shape_sig.ml | 2 +- .../compute/owl_computation_symbol_sig.ml | 2 +- src/base/compute/owl_computation_type_sig.ml | 2 +- src/base/core/owl_const.mli | 14 +-- src/base/core/owl_exception.mli | 4 +- src/base/core/owl_graph.mli | 10 +- src/base/core/owl_lazy.mli | 12 +-- src/base/core/owl_operator.mli | 10 +- .../dense/owl_base_dense_matrix_generic.mli | 2 +- .../dense/owl_base_dense_ndarray_generic.mli | 28 ++--- src/base/dense/owl_base_dense_ndarray_intf.ml | 6 +- src/base/linalg/owl_base_linalg_generic.mli | 12 +-- src/base/linalg/owl_base_linalg_intf.ml | 6 +- src/base/maths/owl_base_complex.mli | 10 +- src/base/maths/owl_base_maths.mli | 6 +- src/base/maths/owl_maths_quadrature.mli | 4 +- src/base/maths/owl_maths_root.mli | 8 +- src/base/misc/owl_countmin_sketch_sig.ml | 4 +- src/base/misc/owl_countmin_table.ml | 4 +- src/base/misc/owl_dataframe.mli | 18 ++-- src/base/misc/owl_heavyhitters_sketch_sig.ml | 4 +- src/base/misc/owl_io.mli | 6 +- src/base/misc/owl_log.mli | 6 +- src/base/misc/owl_pretty.mli | 4 +- src/base/misc/owl_utils_array.mli | 4 +- src/base/misc/owl_utils_heap.mli | 4 +- src/base/misc/owl_utils_multimap.mli | 4 +- src/base/misc/owl_utils_stack.mli | 4 +- src/base/misc/owl_view.mli | 10 +- src/base/neural/owl_neural_graph_sig.ml | 12 +-- src/base/neural/owl_neural_neuron_sig.ml | 102 +++++++++--------- src/base/optimise/owl_numdiff_generic_sig.ml | 4 +- src/base/optimise/owl_optimise_generic_sig.ml | 2 +- src/base/stats/owl_base_stats.mli | 6 +- .../types/owl_types_computation_device.ml | 4 +- .../types/owl_types_computation_engine.ml | 2 +- src/opencl/owl_opencl_base.mli | 16 +-- src/opencl/owl_opencl_context.mli | 10 +- src/opencl/owl_opencl_dense_ndarray.mli | 6 +- src/opencl/owl_opencl_generated.ml | 10 +- src/opencl/owl_opencl_generated.mli | 8 +- .../owl_types_computation_opencl_device.ml | 6 +- src/owl/cblas/owl_cblas.mli | 8 +- src/owl/cblas/owl_cblas_basic.mli | 8 +- src/owl/dense/owl_dense_matrix_generic.mli | 24 ++--- src/owl/dense/owl_dense_matrix_intf.ml | 26 ++--- src/owl/dense/owl_dense_ndarray_a.mli | 12 +-- src/owl/dense/owl_dense_ndarray_generic.mli | 32 +++--- src/owl/dense/owl_dense_ndarray_intf.ml | 32 +++--- src/owl/fftpack/owl_fft_generic.mli | 2 +- src/owl/lapacke/owl_lapacke.mli | 4 +- src/owl/linalg/owl_linalg_generic.mli | 18 ++-- src/owl/linalg/owl_linalg_intf.ml | 14 +-- src/owl/maths/owl_maths.mli | 26 ++--- src/owl/neural/owl_neural.ml | 4 +- src/owl/nlp/owl_nlp_corpus.mli | 12 +-- src/owl/nlp/owl_nlp_lda.mli | 6 +- src/owl/nlp/owl_nlp_tfidf.mli | 12 +-- src/owl/nlp/owl_nlp_vocabulary.mli | 10 +- .../optimise/owl_regression_generic_sig.ml | 4 +- src/owl/ppl/owl_distribution.mli | 38 +++---- src/owl/sparse/owl_sparse_dok_matrix.mli | 10 +- src/owl/sparse/owl_sparse_matrix_c.mli | 18 ++-- src/owl/sparse/owl_sparse_matrix_d.mli | 18 ++-- src/owl/sparse/owl_sparse_matrix_generic.mli | 20 ++-- src/owl/sparse/owl_sparse_matrix_s.mli | 18 ++-- src/owl/sparse/owl_sparse_matrix_z.mli | 18 ++-- src/owl/sparse/owl_sparse_ndarray_c.mli | 16 +-- src/owl/sparse/owl_sparse_ndarray_d.mli | 16 +-- src/owl/sparse/owl_sparse_ndarray_generic.mli | 18 ++-- src/owl/sparse/owl_sparse_ndarray_s.mli | 16 +-- src/owl/sparse/owl_sparse_ndarray_z.mli | 16 +-- src/owl/stats/owl_stats.mli | 12 +-- src/plplot/owl_plot.mli | 10 +- src/top/owl_top.mli | 2 +- src/zoo/owl_zoo_cmd.mli | 6 +- 82 files changed, 466 insertions(+), 466 deletions(-) diff --git a/src/base/algodiff/owl_algodiff_core_sig.ml b/src/base/algodiff/owl_algodiff_core_sig.ml index b91f41bb6..98ed9e92a 100644 --- a/src/base/algodiff/owl_algodiff_core_sig.ml +++ b/src/base/algodiff/owl_algodiff_core_sig.ml @@ -6,11 +6,11 @@ module type Sig = sig module A : Owl_types_ndarray_algodiff.Sig - (** {6 Type definition} *) + (** {5 Type definition} *) include Owl_algodiff_types_sig.Sig with type elt := A.elt and type arr := A.arr - (** {6 Core functions} *) + (** {5 Core functions} *) val tag : unit -> int (** TODO *) diff --git a/src/base/algodiff/owl_algodiff_generic_sig.ml b/src/base/algodiff/owl_algodiff_generic_sig.ml index efdbdb23e..2ac09eed0 100644 --- a/src/base/algodiff/owl_algodiff_generic_sig.ml +++ b/src/base/algodiff/owl_algodiff_generic_sig.ml @@ -92,7 +92,7 @@ module type Sig = sig and type arr := A.arr and type op := op - (** {6 Helper functions} *) + (** {5 Helper functions} *) include Owl_algodiff_graph_convert_sig.Sig with type t := t end diff --git a/src/base/algodiff/owl_algodiff_ops_sig.ml b/src/base/algodiff/owl_algodiff_ops_sig.ml index 54105201f..b7b77af33 100644 --- a/src/base/algodiff/owl_algodiff_ops_sig.ml +++ b/src/base/algodiff/owl_algodiff_ops_sig.ml @@ -14,7 +14,7 @@ module type Sig = sig type op - (** {6 Ops Builder } *) + (** {5 Ops Builder } *) module Builder : Owl_algodiff_ops_builder_sig.Sig with type t := t @@ -22,7 +22,7 @@ module type Sig = sig and type arr := arr and type op := op - (** {6 Supported Maths functions} *) + (** {5 Supported Maths functions} *) module Maths : sig val ( + ) : t -> t -> t @@ -254,7 +254,7 @@ module type Sig = sig (** Refer to :doc:`owl_dense_ndarray_generic` *) end - (** {6 Supported Linalg functions} *) + (** {5 Supported Linalg functions} *) module Linalg : sig val inv : t -> t @@ -294,7 +294,7 @@ module type Sig = sig (** Refer to :doc:`owl_dense_ndarray_generic` *) end - (** {6 Supported Neural Network functions} *) + (** {5 Supported Neural Network functions} *) module NN : sig val dropout : ?rate:float -> t -> t @@ -356,7 +356,7 @@ module type Sig = sig stuff all the time. Some operations just interface to those already defined in the Maths module. *) - (** {6 Supported Mat functions} *) + (** {5 Supported Mat functions} *) module Mat : sig val empty : int -> int -> t @@ -410,7 +410,7 @@ module type Sig = sig val print : t -> unit end - (** {6 Supported Arr functions} *) + (** {5 Supported Arr functions} *) module Arr : sig val empty : int array -> t diff --git a/src/base/compute/owl_computation_graph_sig.ml b/src/base/compute/owl_computation_graph_sig.ml index 81a94b493..a7269d799 100644 --- a/src/base/compute/owl_computation_graph_sig.ml +++ b/src/base/compute/owl_computation_graph_sig.ml @@ -9,12 +9,12 @@ module type Sig = sig open Optimiser.Operator.Symbol.Shape.Type open Optimiser.Operator.Symbol.Shape.Type.Device - (** {6 Type definition} *) + (** {5 Type definition} *) type graph (** TODO *) - (** {6 Core functions} *) + (** {5 Core functions} *) val shape_or_value : t -> string (** TODO *) diff --git a/src/base/compute/owl_computation_operator_sig.ml b/src/base/compute/owl_computation_operator_sig.ml index 0ea36e622..ccb91d346 100644 --- a/src/base/compute/owl_computation_operator_sig.ml +++ b/src/base/compute/owl_computation_operator_sig.ml @@ -12,7 +12,7 @@ module type Sig = sig open Symbol.Shape.Type - (** {6 Vectorised functions} *) + (** {5 Vectorised functions} *) val noop : arr -> arr (** TODO *) @@ -568,7 +568,7 @@ module type Sig = sig val to_arrays : arr -> elt array array (** TODO *) - (** {6 Scalar functions} *) + (** {5 Scalar functions} *) module Scalar : sig val add : elt -> elt -> elt diff --git a/src/base/compute/owl_computation_optimiser_sig.ml b/src/base/compute/owl_computation_optimiser_sig.ml index 1dafe2ddf..dfd2e65d6 100644 --- a/src/base/compute/owl_computation_optimiser_sig.ml +++ b/src/base/compute/owl_computation_optimiser_sig.ml @@ -10,7 +10,7 @@ module type Sig = sig open Operator.Symbol.Shape.Type - (** {6 Core functions} *) + (** {5 Core functions} *) val estimate_complexity : 'a Owl_graph.node array -> int * int (** TODO *) diff --git a/src/base/compute/owl_computation_shape_sig.ml b/src/base/compute/owl_computation_shape_sig.ml index 6f844ac45..4303ae498 100644 --- a/src/base/compute/owl_computation_shape_sig.ml +++ b/src/base/compute/owl_computation_shape_sig.ml @@ -10,7 +10,7 @@ module type Sig = sig open Type - (** {6 Core functions} *) + (** {5 Core functions} *) val infer_shape : op -> attr Owl_graph.node array -> int array option array (** TODO *) diff --git a/src/base/compute/owl_computation_symbol_sig.ml b/src/base/compute/owl_computation_symbol_sig.ml index a75c9a847..a3d13bc52 100644 --- a/src/base/compute/owl_computation_symbol_sig.ml +++ b/src/base/compute/owl_computation_symbol_sig.ml @@ -12,7 +12,7 @@ module type Sig = sig open Type open Device - (** {6 Core functions} *) + (** {5 Core functions} *) val op_to_str : op -> string (** TODO *) diff --git a/src/base/compute/owl_computation_type_sig.ml b/src/base/compute/owl_computation_type_sig.ml index 44ad72313..709607237 100644 --- a/src/base/compute/owl_computation_type_sig.ml +++ b/src/base/compute/owl_computation_type_sig.ml @@ -12,7 +12,7 @@ module type Sig = sig open Device - (** {6 Type definition} *) + (** {5 Type definition} *) type state = | Valid diff --git a/src/base/core/owl_const.mli b/src/base/core/owl_const.mli index 3b5bdb122..7c76909e4 100644 --- a/src/base/core/owl_const.mli +++ b/src/base/core/owl_const.mli @@ -21,7 +21,7 @@ http://www.npl.co.uk/upload/pdf/units-of-measurement-poster.pdf *) -(** {6 Maths constants} *) +(** {5 Maths constants} *) val e : float (** e = 2.718281828459045235360287471352662498 *) @@ -74,7 +74,7 @@ val pi_4 : float val eps : float (** eps = 1e-15 *) -(** {6 Constants depending on Bigarray kind} *) +(** {5 Constants depending on Bigarray kind} *) val zero : ('a, 'b) Bigarray.kind -> 'a (** ``zero kind`` returns value zero of the given number type ``kind``. *) @@ -103,7 +103,7 @@ val min_float64 : float val max_float64 : float (** Maximum value of double precision float number. *) -(** {6 Unit prefixes} *) +(** {5 Unit prefixes} *) module Prefix : sig val fine_structure : float @@ -173,7 +173,7 @@ module Prefix : sig (** yocto = 1e-24 *) end -(** {6 SI: International System of Units} *) +(** {5 SI: International System of Units} *) module SI : sig val speed_of_light : float @@ -480,7 +480,7 @@ module SI : sig (** gauss = 1e-4 *) end -(** {6 MKS: MKS system of units} *) +(** {5 MKS: MKS system of units} *) module MKS : sig val speed_of_light : float @@ -787,7 +787,7 @@ module MKS : sig (** gauss = 1e-4 *) end -(** {6 CGS: Centimetre–gram–second system of units} *) +(** {5 CGS: Centimetre–gram–second system of units} *) module CGS : sig val speed_of_light : float @@ -1064,7 +1064,7 @@ module CGS : sig (** thomson_cross_section = 6.65245893699e-25 *) end -(** {6 CGSM: Unit Systems in Electromagnetism} *) +(** {5 CGSM: Unit Systems in Electromagnetism} *) module CGSM : sig val speed_of_light : float diff --git a/src/base/core/owl_exception.mli b/src/base/core/owl_exception.mli index 30b6e6d49..9af3db72c 100644 --- a/src/base/core/owl_exception.mli +++ b/src/base/core/owl_exception.mli @@ -3,7 +3,7 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Core function} *) +(** {5 Core function} *) val check : bool -> exn -> unit (** @@ -41,7 +41,7 @@ val pp_exception : Format.formatter -> exn -> unit [@@ocaml.toplevel_printer] (** ``pp_exception`` is the pretty printer for Owl exceptions. *) -(** {6 Exception definition} *) +(** {5 Exception definition} *) exception CONV_INVALID_ARGUMENT (** Input arguments of convolution operations are invalid. *) diff --git a/src/base/core/owl_graph.mli b/src/base/core/owl_graph.mli index 5051ff0fa..d046a6dca 100644 --- a/src/base/core/owl_graph.mli +++ b/src/base/core/owl_graph.mli @@ -5,7 +5,7 @@ (** Graph module supports basic operations on DAG. *) -(** {6 Type definition} *) +(** {5 Type definition} *) type order = | BFS @@ -22,7 +22,7 @@ type dir = type 'a node (** type definition of a node *) -(** {6 Obtaining properties} *) +(** {5 Obtaining properties} *) val id : 'a node -> int (** ``id x`` returns the id of node ``x``. *) @@ -69,7 +69,7 @@ val num_descendant : 'a node array -> int val length : 'a node array -> int (** ``length x`` returns the total number of ancestors and descendants of ``x``. *) -(** {6 Manipulation functions} *) +(** {5 Manipulation functions} *) val node : ?id:int @@ -148,7 +148,7 @@ fields of the nodes in the new graph share the same memory with those in the original graph. *) -(** {6 Iterators} *) +(** {5 Iterators} *) val iter_ancestors : ?order:order @@ -190,7 +190,7 @@ val fold_in_edges : ('b -> 'a node -> 'a node -> 'b) -> 'b -> 'a node array -> ' val fold_out_edges : ('b -> 'a node -> 'a node -> 'b) -> 'b -> 'a node array -> 'b (** Fold all the out-edges of a given node. *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val topo_sort : 'a node array -> 'a node array (** diff --git a/src/base/core/owl_lazy.mli b/src/base/core/owl_lazy.mli index 037b06d2c..96072a865 100644 --- a/src/base/core/owl_lazy.mli +++ b/src/base/core/owl_lazy.mli @@ -12,7 +12,7 @@ open Owl_graph *) module Make (A : Ndarray_Mutable) : sig - (** {6 Type definition} *) + (** {5 Type definition} *) type arr (** TODO *) @@ -29,7 +29,7 @@ module Make (A : Ndarray_Mutable) : sig type graph (** TODO *) - (** {6 Type conversion functions} *) + (** {5 Type conversion functions} *) val arr_to_value : A.arr -> value (** TODO *) @@ -76,7 +76,7 @@ module Make (A : Ndarray_Mutable) : sig val elt_to_float : elt -> float (** TODO *) - (** {6 Utility functions} *) + (** {5 Utility functions} *) val graph_to_dot : graph -> string (** TODO *) @@ -84,7 +84,7 @@ module Make (A : Ndarray_Mutable) : sig val graph_to_trace : graph -> string (** TODO *) - (** {6 Create variables} *) + (** {5 Create variables} *) val var_arr : ?shape:int array -> string -> arr (** TODO *) @@ -107,7 +107,7 @@ module Make (A : Ndarray_Mutable) : sig val unsafe_assign_arr : arr -> A.arr -> unit (** TODO *) - (** {6 Maths functions} *) + (** {5 Maths functions} *) val noop : arr -> arr (** TODO *) @@ -541,7 +541,7 @@ module Make (A : Ndarray_Mutable) : sig val of_arrays : elt array array -> arr (** TODO *) - (** {6 Evaluation functions} *) + (** {5 Evaluation functions} *) val make_graph : input:attr node array -> output:attr node array -> string -> graph (** TODO *) diff --git a/src/base/core/owl_operator.mli b/src/base/core/owl_operator.mli index cc00c10b3..c58ee955c 100644 --- a/src/base/core/owl_operator.mli +++ b/src/base/core/owl_operator.mli @@ -5,7 +5,7 @@ open Owl_types_operator -(** {6 Basic operators} *) +(** {5 Basic operators} *) module Make_Basic (M : BasicSig) : sig val ( + ) : ('a, 'b) M.t -> ('a, 'b) M.t -> ('a, 'b) M.t @@ -66,7 +66,7 @@ module Make_Basic (M : BasicSig) : sig (** Operator of ``less_equal`` *) end -(** {6 Extended operators} *) +(** {5 Extended operators} *) module Make_Extend (M : ExtendSig) : sig val ( =$ ) : ('a, 'b) M.t -> 'a -> bool @@ -202,7 +202,7 @@ module Make_Extend (M : ExtendSig) : sig (** Operator of ``set_slice`` *) end -(** {6 Matrix-specific operators} *) +(** {5 Matrix-specific operators} *) module Make_Matrix (M : MatrixSig) : sig val ( *@ ) : ('a, 'b) M.t -> ('a, 'b) M.t -> ('a, 'b) M.t @@ -215,7 +215,7 @@ module Make_Matrix (M : MatrixSig) : sig (** Operator of ``set`` *) end -(** {6 Ndarray-specific operators} *) +(** {5 Ndarray-specific operators} *) module Make_Ndarray (M : NdarraySig) : sig val ( .%{;..} ) : ('a, 'b) M.t -> int array -> 'a @@ -225,7 +225,7 @@ module Make_Ndarray (M : NdarraySig) : sig (** Operator of ``set`` *) end -(** {6 Linalg-specific operators} *) +(** {5 Linalg-specific operators} *) module Make_Linalg (M : LinalgSig) : sig val ( **@ ) : ('a, 'b) M.t -> float -> ('a, 'b) M.t diff --git a/src/base/dense/owl_base_dense_matrix_generic.mli b/src/base/dense/owl_base_dense_matrix_generic.mli index 0220a057f..2cfddc5c2 100644 --- a/src/base/dense/owl_base_dense_matrix_generic.mli +++ b/src/base/dense/owl_base_dense_matrix_generic.mli @@ -20,7 +20,7 @@ aforementioned conventions. open Bigarray -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t = ('a, 'b, c_layout) Genarray.t (** diff --git a/src/base/dense/owl_base_dense_ndarray_generic.mli b/src/base/dense/owl_base_dense_ndarray_generic.mli index db4849b0e..b3306e411 100644 --- a/src/base/dense/owl_base_dense_ndarray_generic.mli +++ b/src/base/dense/owl_base_dense_ndarray_generic.mli @@ -21,7 +21,7 @@ aforementioned conventions. open Bigarray open Owl_types -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t = ('a, 'b, c_layout) Genarray.t (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -29,7 +29,7 @@ type ('a, 'b) t = ('a, 'b, c_layout) Genarray.t type ('a, 'b) kind = ('a, 'b) Bigarray.kind (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Create Ndarrays} *) +(** {5 Create Ndarrays} *) val empty : ('a, 'b) kind -> int array -> ('a, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -64,7 +64,7 @@ val sequential : ('a, 'b) kind -> ?a:'a -> ?step:'a -> int array -> ('a, 'b) t val bernoulli : ('a, 'b) kind -> ?p:float -> int array -> ('a, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : ('a, 'b) t -> int array (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -87,7 +87,7 @@ val strides : ('a, 'b) t -> int array val slice_size : ('a, 'b) t -> int array (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Manipulate Ndarrays} *) +(** {5 Manipulate Ndarrays} *) val get : ('a, 'b) t -> int array -> 'a (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -155,7 +155,7 @@ val draw : ?axis:int -> ('a, 'b) t -> int -> ('a, 'b) t * int array val one_hot : int -> ('a, 'b) t -> ('a, 'b) t (** TODO: not implemented *) -(** {6 Iterate array elements} *) +(** {5 Iterate array elements} *) val iteri : (int -> 'a -> unit) -> ('a, 'b) t -> unit (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -187,7 +187,7 @@ val scani : ?axis:int -> (int -> 'a -> 'a -> 'a) -> ('a, 'b) t -> ('a, 'b) t val scan : ?axis:int -> ('a -> 'a -> 'a) -> ('a, 'b) t -> ('a, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Examination & Comparison} *) +(** {5 Examination & Comparison} *) val exists : ('a -> bool) -> ('a, 'b) t -> bool (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -310,7 +310,7 @@ val approx_elt_equal : ?eps:float -> (float, 'b) t -> (float, 'b) t -> (float, ' val approx_elt_equal_scalar : ?eps:float -> (float, 'b) t -> float -> (float, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Input/Output functions} *) +(** {5 Input/Output functions} *) val of_array : ('a, 'b) kind -> 'a array -> int array -> ('a, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -327,7 +327,7 @@ val print val load : ('a, 'b) kind -> string -> ('a, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Unary math operators } *) +(** {5 Unary math operators } *) val min : ?axis:int -> ?keep_dims:bool -> ('a, 'b) t -> ('a, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -490,7 +490,7 @@ val l2norm' : (float, 'b) t -> float val l2norm_sqr' : (float, 'b) t -> float (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Binary math operators} *) +(** {5 Binary math operators} *) val add : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -571,7 +571,7 @@ val clip_by_l2norm : float -> (float, 'a) t -> (float, 'a) t val fma : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Neural network related} *) +(** {5 Neural network related} *) val conv1d : ?padding:padding @@ -906,13 +906,13 @@ val avg_pool3d_backward val upsampling2d_backward : (float, 'a) t -> int array -> (float, 'a) t -> (float, 'a) t (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Helper functions } *) +(** {5 Helper functions } *) (* TODO: change float to 'a *) val sum_slices : ?axis:int -> (float, 'b) t -> (float, 'b) t (** Refer to :doc:`owl_dense_ndarray_generic` *) -(** {6 Matrix functions} *) +(** {5 Matrix functions} *) val row_num : ('a, 'b) t -> int (** Refer to :doc:`owl_dense_matrix_generic` *) @@ -970,7 +970,7 @@ val draw_rows2 (** Refer to :doc:`owl_dense_matrix_generic` *) (* -(** {6 In-place modification} *) +(** {5 In-place modification} *) val create_ : out:('a, 'b) t -> 'a -> unit (** TODO *) @@ -1423,7 +1423,7 @@ val fused_adagrad_ : ?out:('a, 'b) t -> rate:'a -> eps:'a -> ('a, 'b) t -> unit (** TODO *) *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val float_to_elt : 'a -> 'a (** Identity function to deal with the type conversion required by other functors. *) diff --git a/src/base/dense/owl_base_dense_ndarray_intf.ml b/src/base/dense/owl_base_dense_ndarray_intf.ml index a4395319d..5c8c2c81e 100644 --- a/src/base/dense/owl_base_dense_ndarray_intf.ml +++ b/src/base/dense/owl_base_dense_ndarray_intf.ml @@ -188,7 +188,7 @@ module type Common = sig val fma : arr -> arr -> arr -> arr - (** {6 Iterate array elements} *) + (** {5 Iterate array elements} *) val iteri : (int -> elt -> unit) -> arr -> unit @@ -210,7 +210,7 @@ module type Common = sig val scan : ?axis:int -> (elt -> elt -> elt) -> arr -> arr - (** {6 Examination & Comparison} *) + (** {5 Examination & Comparison} *) val exists : (elt -> bool) -> arr -> bool @@ -360,7 +360,7 @@ module type Real = sig val trace : arr -> elt - (** {6 Helper functions} *) + (** {5 Helper functions} *) val float_to_elt : float -> elt diff --git a/src/base/linalg/owl_base_linalg_generic.mli b/src/base/linalg/owl_base_linalg_generic.mli index 13c3a8ffd..07548cf98 100644 --- a/src/base/linalg/owl_base_linalg_generic.mli +++ b/src/base/linalg/owl_base_linalg_generic.mli @@ -5,11 +5,11 @@ open Bigarray -(** {6 Types and constants} *) +(** {5 Types and constants} *) type ('a, 'b) t = ('a, 'b) Owl_base_dense_ndarray_generic.t -(** {6 Basic functions} *) +(** {5 Basic functions} *) val inv : ('a, 'b) t -> ('a, 'b) t (** @@ -24,7 +24,7 @@ val det : ('a, 'b) t -> 'a val logdet : ('a, 'b) t -> 'a (** Refer to :doc:`owl_dense_matrix_generic` *) -(** {6 Check matrix types} *) +(** {5 Check matrix types} *) val is_tril : ('a, 'b) t -> bool (** ``is_tril x`` returns ``true`` if ``x`` is lower triangular otherwise ``false``. *) @@ -41,7 +41,7 @@ val is_symmetric : ('a, 'b) t -> bool val is_hermitian : (Complex.t, 'b) t -> bool (** ``is_hermitian x`` returns ``true`` if ``x`` is hermitian otherwise ``false``. *) -(** {6 Factorisation} *) +(** {5 Factorisation} *) val lu : ('a, 'b) t -> ('a, 'b) t * ('a, 'b) t * int array (** @@ -65,7 +65,7 @@ val svd : ?thin:bool -> ('a, 'b) t -> ('a, 'b) t * ('a, 'b) t * ('a, 'b) t val chol : ?upper:bool -> ('a, 'b) t -> ('a, 'b) t (** Refer to :doc:`owl_dense_matrix_generic` *) -(** {6 Linear system of equations} *) +(** {5 Linear system of equations} *) val linsolve : ?trans:bool @@ -97,7 +97,7 @@ val care -> (float, 'b) t (** Refer to :doc:`owl_dense_matrix_generic` *) -(** {6 Non-standard functions} *) +(** {5 Non-standard functions} *) val linsolve_lu : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t diff --git a/src/base/linalg/owl_base_linalg_intf.ml b/src/base/linalg/owl_base_linalg_intf.ml index d0153f7fc..2bbbf0181 100644 --- a/src/base/linalg/owl_base_linalg_intf.ml +++ b/src/base/linalg/owl_base_linalg_intf.ml @@ -12,7 +12,7 @@ module type Common = sig type int32_mat - (** {6 Basic functions} *) + (** {5 Basic functions} *) val inv : mat -> mat @@ -28,7 +28,7 @@ module type Common = sig val is_diag : mat -> bool - (** {6 Factorisation} *) + (** {5 Factorisation} *) val svd : ?thin:bool -> mat -> mat * mat * mat @@ -38,7 +38,7 @@ module type Common = sig val lq : ?thin:bool -> mat -> mat * mat - (** {6 Linear system of equations} *) + (** {5 Linear system of equations} *) val linsolve : ?trans:bool -> ?typ:[ `n | `u | `l ] -> mat -> mat -> mat diff --git a/src/base/maths/owl_base_complex.mli b/src/base/maths/owl_base_complex.mli index aff00fef7..a1be42af1 100644 --- a/src/base/maths/owl_base_complex.mli +++ b/src/base/maths/owl_base_complex.mli @@ -3,7 +3,7 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Type definition and constants} *) +(** {5 Type definition and constants} *) type t = Complex.t (** Type definition of a complex number. *) @@ -17,7 +17,7 @@ val one : t val i : t (** Constant value i. *) -(** {6 Unary functions} *) +(** {5 Unary functions} *) val neg : t -> t (** TODO *) @@ -157,7 +157,7 @@ val trunc : t -> t val fix : t -> t (** ``fix x`` *) -(** {6 Binary functions} *) +(** {5 Binary functions} *) val add : t -> t -> t (** TODO *) @@ -204,7 +204,7 @@ val polar : float -> float -> t val rect : float -> float -> t (** ``rect r phi`` return a complex number with polar coordinates ``r`` and ``phi``. *) -(** {6 Comparison functions} *) +(** {5 Comparison functions} *) val equal : t -> t -> bool (** TODO *) @@ -224,7 +224,7 @@ val less_equal : t -> t -> bool val greater_equal : t -> t -> bool (** TODO *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val complex : float -> float -> t (** ``complex re im`` returns a complex number ``{re; im}``. *) diff --git a/src/base/maths/owl_base_maths.mli b/src/base/maths/owl_base_maths.mli index ad721da83..1431d03be 100644 --- a/src/base/maths/owl_base_maths.mli +++ b/src/base/maths/owl_base_maths.mli @@ -5,7 +5,7 @@ (** Maths: fundamental and advanced mathematical functions. *) -(** {6 Basic functions} *) +(** {5 Basic functions} *) val add : float -> float -> float (** ``add x y`` *) @@ -187,7 +187,7 @@ val log1mexp : float -> float val log1pexp : float -> float (** ``log1pexp(x)`` *) -(** {6 Error functions} *) +(** {5 Error functions} *) val erf : float -> float (** ``erf(x)`` *) @@ -198,7 +198,7 @@ val erfc : float -> float val erfcx : float -> float (** ``erfcx(x)`` *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val is_nan : float -> bool (** ``is_nan x`` returns ``true`` if ``x`` is ``nan``. *) diff --git a/src/base/maths/owl_maths_quadrature.mli b/src/base/maths/owl_maths_quadrature.mli index a916ef98b..338d2dd23 100644 --- a/src/base/maths/owl_maths_quadrature.mli +++ b/src/base/maths/owl_maths_quadrature.mli @@ -5,7 +5,7 @@ (** Numerical Integration *) -(** {6 Integration functions} *) +(** {5 Integration functions} *) val trapz : ?n:int -> ?eps:float -> (float -> float) -> float -> float -> float (** @@ -88,7 +88,7 @@ Returns: * ``y``: the integral of ``f`` on ``[a, b]``. *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val trapzd : (float -> float) -> float -> float -> int -> float (** diff --git a/src/base/maths/owl_maths_root.mli b/src/base/maths/owl_maths_root.mli index a4d42816c..ab9bf2e01 100644 --- a/src/base/maths/owl_maths_root.mli +++ b/src/base/maths/owl_maths_root.mli @@ -5,7 +5,7 @@ (** Root finding algorithms for nonlinear functions *) -(** {6 Type definition} *) +(** {5 Type definition} *) type solver = | Bisec @@ -13,7 +13,7 @@ type solver = | Ridder | Brent (** Type of root functions of univariate functions. *) -(** {6 Core functions} *) +(** {5 Core functions} *) val fzero : ?solver:solver @@ -38,7 +38,7 @@ Parameters: * ``b``: boundary of bracket. *) -(** {6 Root of univariate functions} *) +(** {5 Root of univariate functions} *) val bisec : ?max_iter:int -> ?xtol:float -> (float -> float) -> float -> float -> float (** @@ -100,7 +100,7 @@ Parameters: Refer to :cite:`brent2013algorithms` *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val bracket_expand : ?rate:float diff --git a/src/base/misc/owl_countmin_sketch_sig.ml b/src/base/misc/owl_countmin_sketch_sig.ml index 970d3bb73..6b8373f1f 100644 --- a/src/base/misc/owl_countmin_sketch_sig.ml +++ b/src/base/misc/owl_countmin_sketch_sig.ml @@ -13,12 +13,12 @@ * for more details. *) module type Sig = sig - (** {6 Type definition} *) + (** {5 Type definition} *) type 'a sketch (** The type of Count-Min sketches *) - (** {6 Core functions} *) + (** {5 Core functions} *) val init : epsilon:float -> delta:float -> 'a sketch (** diff --git a/src/base/misc/owl_countmin_table.ml b/src/base/misc/owl_countmin_table.ml index f10baeb41..d98a982ce 100644 --- a/src/base/misc/owl_countmin_table.ml +++ b/src/base/misc/owl_countmin_table.ml @@ -1,11 +1,11 @@ (* A module type for the tables used to implement the CountMin sketch. *) module type Sig = sig - (** {6 Type definition} *) + (** {5 Type definition} *) type t (** The type of count-min tables *) - (** {6 Core functions} *) + (** {5 Core functions} *) val init : int -> int -> t (** diff --git a/src/base/misc/owl_dataframe.mli b/src/base/misc/owl_dataframe.mli index 4b06457cf..f6c61e125 100644 --- a/src/base/misc/owl_dataframe.mli +++ b/src/base/misc/owl_dataframe.mli @@ -3,7 +3,7 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Type definition} *) +(** {5 Type definition} *) type t (** Abstract dataframe type. *) @@ -22,7 +22,7 @@ type elt = | String of string | Any (** Type of the elements in a series. *) -(** {6 Pakcking & unpacking element} *) +(** {5 Pakcking & unpacking element} *) val pack_bool : bool -> elt (** Pack the boolean value to ``elt`` type. *) @@ -48,7 +48,7 @@ val unpack_float : elt -> float val unpack_string : elt -> string (** Unpack ``elt`` type to string value. *) -(** {6 Pakcking & unpacking series} *) +(** {5 Pakcking & unpacking series} *) val pack_bool_series : bool array -> series (** Pack boolean array to ``series`` type. *) @@ -74,7 +74,7 @@ val unpack_float_series : series -> float array val unpack_string_series : series -> string array (** Unpack ``series`` type to string array. *) -(** {6 Obtain properties} *) +(** {5 Obtain properties} *) val row_num : t -> int (** ``row_num x`` returns the number of rows in ``x``. *) @@ -103,7 +103,7 @@ val id_to_head : t -> int -> string val head_to_id : t -> string -> int (** ``head_to_id i`` converts column index ``i`` to its corresponding head name. *) -(** {6 Basic get and set functions} *) +(** {5 Basic get and set functions} *) val get : t -> int -> int -> elt (** ``get x i j`` returns the element at ``(i,j)``. *) @@ -150,7 +150,7 @@ val head : int -> t -> t val tail : int -> t -> t (** ``tail n x`` returns bottom ``n`` rows of ``x``. *) -(** {6 Core operations} *) +(** {5 Core operations} *) val make : ?data:series array -> string array -> t (** @@ -239,7 +239,7 @@ val concat_vertical : t -> t -> t and the same column names. *) -(** {6 Iteration functions} *) +(** {5 Iteration functions} *) val iteri_row : (int -> elt array -> unit) -> t -> unit (** ``iteri_row f x`` iterates the rows of ``x`` and applies ``f``. *) @@ -277,7 +277,7 @@ dataframe; if ``f`` returns ``Some row`` then the row is included. val filter_map_row : (elt array -> elt array option) -> t -> t (** ``filter_map_row`` is similar to ``filter_mapi_row`` without passing in row indices. *) -(** {6 Extended indexing operators} *) +(** {5 Extended indexing operators} *) val ( .%() ) : t -> int * string -> elt (** Extended indexing operator associated with ``get_by_name`` function. *) @@ -299,7 +299,7 @@ transforming. In other words, ``x.?(f) <- g`` means that if ``f row`` is val ( .$() ) : t -> int list * string list -> t (** Extended indexing operator associated with ``get_slice_by_name`` function. *) -(** {6 IO & helper functions} *) +(** {5 IO & helper functions} *) val of_csv : ?sep:char -> ?head:string array -> ?types:string array -> string -> t (** diff --git a/src/base/misc/owl_heavyhitters_sketch_sig.ml b/src/base/misc/owl_heavyhitters_sketch_sig.ml index 28a435314..5c3b48155 100644 --- a/src/base/misc/owl_heavyhitters_sketch_sig.ml +++ b/src/base/misc/owl_heavyhitters_sketch_sig.ml @@ -11,12 +11,12 @@ * section 5.2 (page 12) for more details. *) module type Sig = sig - (** {6 Type definition} *) + (** {5 Type definition} *) type 'a t (** The type of heavy-hitters sketches *) - (** {6 Core functions} *) + (** {5 Core functions} *) val init : k:float -> epsilon:float -> delta:float -> 'a t (** diff --git a/src/base/misc/owl_io.mli b/src/base/misc/owl_io.mli index 896376a74..6162a7f7f 100644 --- a/src/base/misc/owl_io.mli +++ b/src/base/misc/owl_io.mli @@ -3,7 +3,7 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Read and write operations} *) +(** {5 Read and write operations} *) val read_file : ?trim:bool -> string -> string array (** TODO *) @@ -32,7 +32,7 @@ val read_csv_proc : ?sep:char -> (int -> string array -> unit) -> string -> unit val write_csv_proc : ?sep:char -> 'a array array -> ('a -> string) -> string -> unit (** TODO *) -(** {6 Iteration functions} *) +(** {5 Iteration functions} *) val iteri_lines_of_file : ?verbose:bool -> (int -> string -> unit) -> string -> unit (** TODO *) @@ -46,7 +46,7 @@ val iteri_lines_of_marshal : ?verbose:bool -> (int -> 'a -> unit) -> string -> u val mapi_lines_of_marshal : (int -> 'a -> 'b) -> string -> 'b array (** TODO *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val head : int -> string -> string array (** TODO *) diff --git a/src/base/misc/owl_log.mli b/src/base/misc/owl_log.mli index 27e275230..dbbdeb87b 100644 --- a/src/base/misc/owl_log.mli +++ b/src/base/misc/owl_log.mli @@ -5,7 +5,7 @@ (** Log module provides logging functionality. *) -(** {6 Type definition} *) +(** {5 Type definition} *) type level = | DEBUG @@ -19,7 +19,7 @@ function to set global logging level to high one can mask the output from low level logging. *) -(** {6 Configuration functions} *) +(** {5 Configuration functions} *) val set_level : level -> unit (** @@ -37,7 +37,7 @@ val set_color : bool -> unit ``set_color true`` turns on the colour; ``set_color false`` turns it off. *) -(** {6 Log functions} *) +(** {5 Log functions} *) val debug : ('a, out_channel, unit) format -> 'a (** This function outputs log at ``DEBUG`` level. *) diff --git a/src/base/misc/owl_pretty.mli b/src/base/misc/owl_pretty.mli index 33fe3fda4..fda760490 100644 --- a/src/base/misc/owl_pretty.mli +++ b/src/base/misc/owl_pretty.mli @@ -5,7 +5,7 @@ (** Pretty print the n-dimensional array *) -(** {6 Ndarray pretty printer} *) +(** {5 Ndarray pretty printer} *) val pp_dsnda : Format.formatter -> ('a, 'b, 'c) Bigarray.Genarray.t -> unit [@@ocaml.toplevel_printer] @@ -35,7 +35,7 @@ rows and columns to display. [header] specifies whether or not to print out the headers. [fmt] is the function to format every element into string. *) -(** {6 Dataframe pretty printer} *) +(** {5 Dataframe pretty printer} *) val pp_dataframe : Format.formatter -> Owl_dataframe.t -> unit [@@ocaml.toplevel_printer] diff --git a/src/base/misc/owl_utils_array.mli b/src/base/misc/owl_utils_array.mli index cf1658389..19076514b 100644 --- a/src/base/misc/owl_utils_array.mli +++ b/src/base/misc/owl_utils_array.mli @@ -3,7 +3,7 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Basic functions} *) +(** {5 Basic functions} *) val length : 'a array -> int (** Refer to OCaml native array. *) @@ -118,7 +118,7 @@ val unsafe_get : 'a array -> int -> 'a val unsafe_set : 'a array -> int -> 'a -> unit (** Refer to OCaml native array. *) -(** {6 Extended functions} *) +(** {5 Extended functions} *) val ( @ ) : 'a array -> 'a array -> 'a array (** Operator of array concatenation. *) diff --git a/src/base/misc/owl_utils_heap.mli b/src/base/misc/owl_utils_heap.mli index c3ed45676..92c50451f 100644 --- a/src/base/misc/owl_utils_heap.mli +++ b/src/base/misc/owl_utils_heap.mli @@ -3,12 +3,12 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Type definition} *) +(** {5 Type definition} *) type 'a t (** Type of a min heap. *) -(** {6 Basic functions} *) +(** {5 Basic functions} *) val make : ('a -> 'a -> int) -> 'a t (** diff --git a/src/base/misc/owl_utils_multimap.mli b/src/base/misc/owl_utils_multimap.mli index 7cdc8e565..c243c8a82 100644 --- a/src/base/misc/owl_utils_multimap.mli +++ b/src/base/misc/owl_utils_multimap.mli @@ -4,7 +4,7 @@ *) module Make (Ord : Map.OrderedType) : sig - (** {6 Type definition} *) + (** {5 Type definition} *) type key = Ord.t (** Type of the multimap keys. *) @@ -12,7 +12,7 @@ module Make (Ord : Map.OrderedType) : sig type 'a t (** Type of a multimap. *) - (** {6 Basic functions} *) + (** {5 Basic functions} *) val empty : 'a t (** The empty multimap. *) diff --git a/src/base/misc/owl_utils_stack.mli b/src/base/misc/owl_utils_stack.mli index d11296f36..05f886782 100644 --- a/src/base/misc/owl_utils_stack.mli +++ b/src/base/misc/owl_utils_stack.mli @@ -3,12 +3,12 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Type definition} *) +(** {5 Type definition} *) type 'a t (** Type of a stack. *) -(** {6 Basic functions} *) +(** {5 Basic functions} *) val make : unit -> 'a t (** ``make ()`` creates an empty stack. *) diff --git a/src/base/misc/owl_view.mli b/src/base/misc/owl_view.mli index ce3a6670a..2fee4a59f 100644 --- a/src/base/misc/owl_view.mli +++ b/src/base/misc/owl_view.mli @@ -15,12 +15,12 @@ open Owl_types module Make (A : Ndarray_Basic) : sig - (** {6 Type definition} *) + (** {5 Type definition} *) type t (** ``t`` is the abstract type to represent a view atop of an ndarray. *) - (** {6 Conversion functions} *) + (** {5 Conversion functions} *) val of_arr : A.arr -> t (** ``of_arr x`` creates a view from ndarray ``x``. *) @@ -28,7 +28,7 @@ module Make (A : Ndarray_Basic) : sig val to_arr : t -> A.arr (** ``to_arr x`` creates an new ndarray based on the view ``x``. *) - (** {6 Manipulation functions} *) + (** {5 Manipulation functions} *) val get : t -> int array -> A.elt (** Refer to :doc:`owl_dense_ndarray_generic` *) @@ -54,7 +54,7 @@ module Make (A : Ndarray_Basic) : sig val numel : t -> int (** Refer to :doc:`owl_dense_ndarray_generic` *) - (** {6 Iteration functions} *) + (** {5 Iteration functions} *) val iteri : (int -> A.elt -> unit) -> t -> unit (** @@ -103,7 +103,7 @@ Similar to `mapi` but n-d indices are passed in. This function is much slower than `mapi`. *) - (** {6 Examination & Comparison} *) + (** {5 Examination & Comparison} *) val exists : (A.elt -> bool) -> t -> bool (** diff --git a/src/base/neural/owl_neural_graph_sig.ml b/src/base/neural/owl_neural_graph_sig.ml index 9130fcc11..6b8b3e926 100644 --- a/src/base/neural/owl_neural_graph_sig.ml +++ b/src/base/neural/owl_neural_graph_sig.ml @@ -10,7 +10,7 @@ module type Sig = sig open Neuron.Optimise open Neuron.Optimise.Algodiff - (** {6 Type definition} *) + (** {5 Type definition} *) type node = { mutable name : string @@ -31,7 +31,7 @@ module type Sig = sig } (** Type definition of a node and a neural network. *) - (** {6 Manipulate networks} *) + (** {5 Manipulate networks} *) val make_network : ?nnid:string -> int -> node array -> node array -> network (** Create an empty neural network. *) @@ -86,7 +86,7 @@ module type Sig = sig val input_shapes : network -> int array array (** Get input shapes of a network (without batch dimension), i.e. shape of input neurons. *) - (** {6 Interface to optimisation engine} *) + (** {5 Interface to optimisation engine} *) val init : network -> unit (** Initialise the network. *) @@ -133,7 +133,7 @@ module type Sig = sig val model_inputs : network -> A.arr array -> A.arr array (** Make a deep copy of the given network, excluding the neurons marked with ``training = true``. *) - (** {6 Create Neurons} *) + (** {5 Create Neurons} *) val input : ?name:string -> int array -> node (** @@ -647,7 +647,7 @@ Arguments: * ``axis``: Axis along which to concatenate. *) - (** {6 Helper functions} *) + (** {5 Helper functions} *) val to_string : network -> string (** Convert a neural network to its string representation. *) @@ -696,7 +696,7 @@ name of their associated neurons are saved as key-value pairs in a hash table. ``output_names``: Names of nodes to use as outputs. *) - (** {6 Train Networks} *) + (** {5 Train Networks} *) val train_generic : ?state:Checkpoint.state diff --git a/src/base/neural/owl_neural_neuron_sig.ml b/src/base/neural/owl_neural_neuron_sig.ml index f4f995f6a..97fcef3a2 100644 --- a/src/base/neural/owl_neural_neuron_sig.ml +++ b/src/base/neural/owl_neural_neuron_sig.ml @@ -8,7 +8,7 @@ module type Sig = sig open Optimise.Algodiff - (** {6 Init neuron} *) + (** {5 Init neuron} *) module Init : sig type typ = @@ -34,7 +34,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Input neuron} *) + (** {5 Input neuron} *) module Input : sig type neuron_typ = @@ -59,7 +59,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Activation neuron} *) + (** {5 Activation neuron} *) module Activation : sig type typ = @@ -109,7 +109,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Linear neuron} *) + (** {5 Linear neuron} *) module Linear : sig type neuron_typ = @@ -161,7 +161,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 LinearNoBias neuron} *) + (** {5 LinearNoBias neuron} *) module LinearNoBias : sig type neuron_typ = @@ -212,7 +212,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Recurrent neuron} *) + (** {5 Recurrent neuron} *) module Recurrent : sig type neuron_typ = @@ -277,7 +277,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 LSTM neuron} *) + (** {5 LSTM neuron} *) module LSTM : sig type neuron_typ = @@ -341,7 +341,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 GRU neuron} *) + (** {5 GRU neuron} *) module GRU : sig type neuron_typ = @@ -401,7 +401,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Conv1D neuron} *) + (** {5 Conv1D neuron} *) module Conv1D : sig type neuron_typ = @@ -462,7 +462,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Conv2D neuron} *) + (** {5 Conv2D neuron} *) module Conv2D : sig type neuron_typ = @@ -523,7 +523,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Conv3D neuron} *) + (** {5 Conv3D neuron} *) module Conv3D : sig type neuron_typ = @@ -584,7 +584,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 DilatedConv1D neuron} *) + (** {5 DilatedConv1D neuron} *) module DilatedConv1D : sig type neuron_typ = @@ -647,7 +647,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 DilatedConv2D neuron} *) + (** {5 DilatedConv2D neuron} *) module DilatedConv2D : sig type neuron_typ = @@ -710,7 +710,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 DilatedConv3D neuron} *) + (** {5 DilatedConv3D neuron} *) module DilatedConv3D : sig type neuron_typ = @@ -773,7 +773,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 TransposeConv1D neuron} *) + (** {5 TransposeConv1D neuron} *) module TransposeConv1D : sig type neuron_typ = @@ -834,7 +834,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 TransposeConv2D neuron} *) + (** {5 TransposeConv2D neuron} *) module TransposeConv2D : sig type neuron_typ = @@ -895,7 +895,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 TransposeConv3D neuron} *) + (** {5 TransposeConv3D neuron} *) module TransposeConv3D : sig type neuron_typ = @@ -956,7 +956,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 FullyConnected neuron} *) + (** {5 FullyConnected neuron} *) module FullyConnected : sig type neuron_typ = @@ -1008,7 +1008,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 MaxPool1D neuron} *) + (** {5 MaxPool1D neuron} *) module MaxPool1D : sig type neuron_typ = @@ -1039,7 +1039,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 MaxPool2D neuron} *) + (** {5 MaxPool2D neuron} *) module MaxPool2D : sig type neuron_typ = @@ -1070,7 +1070,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 AvgPool1D neuron} *) + (** {5 AvgPool1D neuron} *) module AvgPool1D : sig type neuron_typ = @@ -1101,7 +1101,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 AvgPool2D neuron} *) + (** {5 AvgPool2D neuron} *) module AvgPool2D : sig type neuron_typ = @@ -1132,7 +1132,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 GlobalMaxPool1D neuron} *) + (** {5 GlobalMaxPool1D neuron} *) module GlobalMaxPool1D : sig type neuron_typ = @@ -1160,7 +1160,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 GlobalMaxPool2D neuron} *) + (** {5 GlobalMaxPool2D neuron} *) module GlobalMaxPool2D : sig type neuron_typ = @@ -1188,7 +1188,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 GlobalAvgPool1D neuron} *) + (** {5 GlobalAvgPool1D neuron} *) module GlobalAvgPool1D : sig type neuron_typ = @@ -1216,7 +1216,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 GlobalAvgPool2D neuron} *) + (** {5 GlobalAvgPool2D neuron} *) module GlobalAvgPool2D : sig type neuron_typ = @@ -1244,11 +1244,11 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 UpSampling1D neuron} *) + (** {5 UpSampling1D neuron} *) module UpSampling1D : sig end - (** {6 UpSampling2D neuron} *) + (** {5 UpSampling2D neuron} *) module UpSampling2D : sig type neuron_typ = @@ -1277,15 +1277,15 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 UpSampling3D neuron} *) + (** {5 UpSampling3D neuron} *) module UpSampling3D : sig end - (** {6 Padding1D neuron} *) + (** {5 Padding1D neuron} *) module Padding1D : sig end - (** {6 Padding2D neuron} *) + (** {5 Padding2D neuron} *) module Padding2D : sig type neuron_typ = @@ -1315,11 +1315,11 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Padding3D neuron} *) + (** {5 Padding3D neuron} *) module Padding3D : sig end - (** {6 Lambda neuron} *) + (** {5 Lambda neuron} *) module Lambda : sig type neuron_typ = @@ -1348,7 +1348,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 LambdaArray neuron} *) + (** {5 LambdaArray neuron} *) module LambdaArray : sig type neuron_typ = @@ -1377,7 +1377,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Dropout neuron} *) + (** {5 Dropout neuron} *) module Dropout : sig type neuron_typ = @@ -1406,7 +1406,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Reshape neuron} *) + (** {5 Reshape neuron} *) module Reshape : sig type neuron_typ = @@ -1434,7 +1434,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Flatten neuron} *) + (** {5 Flatten neuron} *) module Flatten : sig type neuron_typ = @@ -1462,7 +1462,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Slice neuron} *) + (** {5 Slice neuron} *) module Slice : sig type neuron_typ = @@ -1492,7 +1492,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Add neuron} *) + (** {5 Add neuron} *) module Add : sig type neuron_typ = @@ -1520,7 +1520,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Mul neuron} *) + (** {5 Mul neuron} *) module Mul : sig type neuron_typ = @@ -1548,7 +1548,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Dot neuron} *) + (** {5 Dot neuron} *) module Dot : sig type neuron_typ = @@ -1576,7 +1576,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Max neuron} *) + (** {5 Max neuron} *) module Max : sig type neuron_typ = @@ -1604,7 +1604,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Average neuron} *) + (** {5 Average neuron} *) module Average : sig type neuron_typ = @@ -1632,7 +1632,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Concatenate neuron} *) + (** {5 Concatenate neuron} *) module Concatenate : sig type neuron_typ = @@ -1661,7 +1661,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Normalisation neuron} *) + (** {5 Normalisation neuron} *) module Normalisation : sig type neuron_typ = @@ -1729,7 +1729,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 GaussianNoise neuron} *) + (** {5 GaussianNoise neuron} *) module GaussianNoise : sig type neuron_typ = @@ -1758,7 +1758,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 GaussianDropout neuron} *) + (** {5 GaussianDropout neuron} *) module GaussianDropout : sig type neuron_typ = @@ -1787,7 +1787,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 AlphaDropout neuron} *) + (** {5 AlphaDropout neuron} *) module AlphaDropout : sig type neuron_typ = @@ -1816,7 +1816,7 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Embedding neuron} *) + (** {5 Embedding neuron} *) module Embedding : sig type neuron_typ = @@ -1868,11 +1868,11 @@ module type Sig = sig (** Return the name of the neuron. *) end - (** {6 Masking neuron} *) + (** {5 Masking neuron} *) module Masking : sig end - (** {6 Core functions} *) + (** {5 Core functions} *) type neuron = | Input of Input.neuron_typ diff --git a/src/base/optimise/owl_numdiff_generic_sig.ml b/src/base/optimise/owl_numdiff_generic_sig.ml index cd7a84c03..f02704070 100644 --- a/src/base/optimise/owl_numdiff_generic_sig.ml +++ b/src/base/optimise/owl_numdiff_generic_sig.ml @@ -12,7 +12,7 @@ open Owl_types (* TODO: unit test *) module type Sig = sig - (** {6 Type definition} *) + (** {5 Type definition} *) type arr (** General ndarray type *) @@ -20,7 +20,7 @@ module type Sig = sig type elt (** Scalar type *) - (** {6 Basic functions} *) + (** {5 Basic functions} *) val diff : (elt -> elt) -> elt -> elt (** derivative of ``f : scalar -> scalar``. *) diff --git a/src/base/optimise/owl_optimise_generic_sig.ml b/src/base/optimise/owl_optimise_generic_sig.ml index d860c0ac8..be581a0c4 100644 --- a/src/base/optimise/owl_optimise_generic_sig.ml +++ b/src/base/optimise/owl_optimise_generic_sig.ml @@ -275,7 +275,7 @@ module type Sig = sig (** Convert the module ``typ`` to its string representation. *) end - (** {5 Core functions} *) + (** {4 Core functions} *) val minimise_weight : ?state:Checkpoint.state diff --git a/src/base/stats/owl_base_stats.mli b/src/base/stats/owl_base_stats.mli index 6ca477b94..584910038 100644 --- a/src/base/stats/owl_base_stats.mli +++ b/src/base/stats/owl_base_stats.mli @@ -9,7 +9,7 @@ tests. The module also includes some basic statistical functions such as mean, variance, skew, and etc. *) -(** {6 Randomisation functions} *) +(** {5 Randomisation functions} *) val shuffle : 'a array -> 'a array (** Refer to :doc:`owl_stats`. *) @@ -20,7 +20,7 @@ val choose : 'a array -> int -> 'a array val sample : 'a array -> int -> 'a array (** Refer to :doc:`owl_stats`. *) -(** {6 Basic statistical functions} *) +(** {5 Basic statistical functions} *) val sum : float array -> float (** Refer to :doc:`owl_stats`. *) @@ -149,7 +149,7 @@ val gaussian_kde -> float array * float array (** Refer to :doc:`owl_stats`. *) -(** {6 Random variables} *) +(** {5 Random variables} *) val uniform_rvs : a:float -> b:float -> float (** Refer to :doc:`owl_stats`. *) diff --git a/src/base/types/owl_types_computation_device.ml b/src/base/types/owl_types_computation_device.ml index 2cd43d13b..bc47b5d07 100644 --- a/src/base/types/owl_types_computation_device.ml +++ b/src/base/types/owl_types_computation_device.ml @@ -6,7 +6,7 @@ module type Sig = sig module A : Owl_types_ndarray_mutable.Sig - (** {6 Type definition} *) + (** {5 Type definition} *) type device (** TODO *) @@ -14,7 +14,7 @@ module type Sig = sig type value (** TODO *) - (** {6 Core functions} *) + (** {5 Core functions} *) val make_device : unit -> device (** TODO *) diff --git a/src/base/types/owl_types_computation_engine.ml b/src/base/types/owl_types_computation_engine.ml index 56fff9280..5d1a0fb42 100644 --- a/src/base/types/owl_types_computation_engine.ml +++ b/src/base/types/owl_types_computation_engine.ml @@ -9,7 +9,7 @@ module type Sig = sig open Graph open Graph.Optimiser.Operator.Symbol.Shape.Type - (** {6 Core evaluation functions of the engine} *) + (** {5 Core evaluation functions of the engine} *) val eval_arr : arr array -> unit (** TODO *) diff --git a/src/opencl/owl_opencl_base.mli b/src/opencl/owl_opencl_base.mli index b618b9294..6d5555bae 100644 --- a/src/opencl/owl_opencl_base.mli +++ b/src/opencl/owl_opencl_base.mli @@ -5,7 +5,7 @@ open Owl_opencl_generated -(** {6 Platform module} *) +(** {5 Platform module} *) module Platform : sig type info = @@ -27,7 +27,7 @@ module Platform : sig (** Get an array of all the available platforms. *) end -(** {6 Device module} *) +(** {5 Device module} *) module Device : sig type info = @@ -68,7 +68,7 @@ module Device : sig (** Get an array of all the available devices on a given platform. *) end -(** {6 Context module} *) +(** {5 Context module} *) module Context : sig type info = @@ -97,7 +97,7 @@ module Context : sig (** Release a resource by decreasing its reference number by 1. *) end -(** {6 Program module} *) +(** {5 Program module} *) module Program : sig type info = @@ -132,7 +132,7 @@ module Program : sig (** Release a resource by decreasing its reference number by 1. *) end -(** {6 Kernel module} *) +(** {5 Kernel module} *) module Kernel : sig type info = @@ -179,7 +179,7 @@ module Kernel : sig (** Release a resource by decreasing its reference number by 1. *) end -(** {6 CommandQueue module} *) +(** {5 CommandQueue module} *) module CommandQueue : sig type info = @@ -218,7 +218,7 @@ module CommandQueue : sig (** Release a resource by decreasing its reference number by 1. *) end -(** {6 Event module} *) +(** {5 Event module} *) module Event : sig type info = @@ -252,7 +252,7 @@ module Event : sig (** Release a resource by decreasing its reference number by 1. *) end -(** {6 Buffer module} *) +(** {5 Buffer module} *) module Buffer : sig type info = diff --git a/src/opencl/owl_opencl_context.mli b/src/opencl/owl_opencl_context.mli index 815fc6bbb..2156ffd94 100644 --- a/src/opencl/owl_opencl_context.mli +++ b/src/opencl/owl_opencl_context.mli @@ -6,7 +6,7 @@ open Bigarray open Owl_opencl_generated -(** {6 Type definition} *) +(** {5 Type definition} *) type num = | F of float @@ -26,7 +26,7 @@ type t = val default : t (** Default context, with all GPU devices included and pre-compiled core kernels. *) -(** {6 Query platform} *) +(** {5 Query platform} *) val platforms : unit -> cl_platform_id array (** List all the platforms on this computer. *) @@ -43,7 +43,7 @@ val gpu_devices : unit -> cl_device_id array val accelerators : unit -> cl_device_id array (** List all the accelerators on this computer. *) -(** {6 Manipulate context} *) +(** {5 Manipulate context} *) val create : cl_device_id array -> string array -> t (** Create a context with the given devices. The corresponding command queues are created and core kernels are compiled. *) @@ -60,7 +60,7 @@ val get_dev : t -> int -> cl_device_id val get_cmdq : t -> cl_device_id -> cl_command_queue (** Return the corresponding command queue object of the given device object and its associated with the context. *) -(** {6 Manipulate kernels} *) +(** {5 Manipulate kernels} *) val kernels : t -> string array (** List all the installed kernels in the given context. *) @@ -79,7 +79,7 @@ val make_kernel : t -> string -> cl_kernel val ba_kernel : ('a, 'b) kind -> string -> cl_program -> cl_kernel (** This function is similar to ``make_kernel`` but specifically for making Bigarray function. *) -(** {6 Evaluate kernels} *) +(** {5 Evaluate kernels} *) val eval : ?param:num array diff --git a/src/opencl/owl_opencl_dense_ndarray.mli b/src/opencl/owl_opencl_dense_ndarray.mli index 425d5fc1e..369f74f32 100644 --- a/src/opencl/owl_opencl_dense_ndarray.mli +++ b/src/opencl/owl_opencl_dense_ndarray.mli @@ -5,7 +5,7 @@ open Owl_opencl_primitive -(** {6 Core functions} *) +(** {5 Core functions} *) val of_ndarray : ('a, 'b) Owl_dense_ndarray_generic.t -> t (** ``of_ndarray x`` *) @@ -13,7 +13,7 @@ val of_ndarray : ('a, 'b) Owl_dense_ndarray_generic.t -> t val to_ndarray : ('a, 'b) Bigarray.kind -> t -> ('a, 'b) Owl_dense_ndarray_generic.t (** ``to_ndarray otyp x`` *) -(** {6 Unary math functions} *) +(** {5 Unary math functions} *) val erf : t -> t (** ``erf x`` *) @@ -138,7 +138,7 @@ val softplus : t -> t val softsign : t -> t (** ``softsign x`` *) -(** {6 Binary math functions} *) +(** {5 Binary math functions} *) val add : t -> t -> t (** ``add x y`` *) diff --git a/src/opencl/owl_opencl_generated.ml b/src/opencl/owl_opencl_generated.ml index f10b2a1ec..05a7c6032 100644 --- a/src/opencl/owl_opencl_generated.ml +++ b/src/opencl/owl_opencl_generated.ml @@ -8,7 +8,7 @@ open Ctypes module CI = Cstubs_internals -(** {6 Type definition} *) +(** {5 Type definition} *) type cl_platform_id = unit Ctypes.ptr @@ -82,7 +82,7 @@ let cl_sampler_null : cl_sampler = Ctypes.null let cl_sampler_ptr_null : cl_sampler Ctypes.ptr = Obj.magic Ctypes.null -(** {6 Function definition} *) +(** {5 Function definition} *) external owl_opencl_clGetPlatformIDs : Unsigned.uint32 @@ -797,7 +797,7 @@ external owl_opencl_clGetExtensionFunctionAddressForPlatform -> CI.voidp = "owl_opencl_stub_79_clGetExtensionFunctionAddressForPlatform" -(** {6 Stub function definition} *) +(** {5 Stub function definition} *) let clGetPlatformIDs x0 x1 x2 = owl_opencl_clGetPlatformIDs x0 (CI.cptr x1) (CI.cptr x2) @@ -1333,7 +1333,7 @@ let clGetExtensionFunctionAddressForPlatform x0 x1 = |> CI.make_ptr void -(** {6 Constants definition} *) +(** {5 Constants definition} *) let cl_SUCCESS = 0 @@ -2061,7 +2061,7 @@ let cl_PROFILING_COMMAND_START = 0x1282 let cl_PROFILING_COMMAND_END = 0x1283 -(** {6 Exception definition} *) +(** {5 Exception definition} *) exception EXN_SUCCESS diff --git a/src/opencl/owl_opencl_generated.mli b/src/opencl/owl_opencl_generated.mli index 19cabe650..33fd8101f 100644 --- a/src/opencl/owl_opencl_generated.mli +++ b/src/opencl/owl_opencl_generated.mli @@ -7,7 +7,7 @@ open Ctypes -(** {6 Type definition} *) +(** {5 Type definition} *) type cl_platform_id (** Type of cl_platform_id *) @@ -117,7 +117,7 @@ val cl_sampler_null : cl_sampler val cl_sampler_ptr_null : cl_sampler Ctypes.ptr (** Null pointer of cl_sampler *) -(** {6 Function definition} *) +(** {5 Function definition} *) val cl_check_err : int32 -> unit (** ``cl_check_err`` checks error code of return value. *) @@ -773,7 +773,7 @@ val clEnqueueBarrierWithWaitList val clGetExtensionFunctionAddressForPlatform : cl_platform_id -> char ptr -> unit ptr (** Refer to `OpenCL `_ *) -(** {6 Constant definition} *) +(** {5 Constant definition} *) val cl_SUCCESS : int (** Constant ``SUCCESS = 0``. *) @@ -1864,7 +1864,7 @@ val cl_PROFILING_COMMAND_START : int val cl_PROFILING_COMMAND_END : int (** Constant ``PROFILING_COMMAND_END = 0x1283``. *) -(** {6 Exception definition} *) +(** {5 Exception definition} *) exception EXN_SUCCESS (** Exception ``EXN_SUCCESS``. *) diff --git a/src/opencl/types/owl_types_computation_opencl_device.ml b/src/opencl/types/owl_types_computation_opencl_device.ml index 5be04e90a..609ea64cf 100644 --- a/src/opencl/types/owl_types_computation_opencl_device.ml +++ b/src/opencl/types/owl_types_computation_opencl_device.ml @@ -8,7 +8,7 @@ open Owl_opencl_generated module type Sig = sig module A : Owl_types_ndarray_mutable.Sig - (** {6 Type definition} *) + (** {5 Type definition} *) type device (** TODO *) @@ -24,7 +24,7 @@ module type Sig = sig } (** TODO *) - (** {6 Core functions} *) + (** {5 Core functions} *) val make_device : unit -> device (** TODO *) @@ -44,7 +44,7 @@ module type Sig = sig val value_to_float : value -> float (** TODO *) - (** {6 OpenCL functions} *) + (** {5 OpenCL functions} *) val make_value : cpu_mem array diff --git a/src/owl/cblas/owl_cblas.mli b/src/owl/cblas/owl_cblas.mli index 31f9e0549..2b54ee6f1 100644 --- a/src/owl/cblas/owl_cblas.mli +++ b/src/owl/cblas/owl_cblas.mli @@ -5,7 +5,7 @@ open Bigarray -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t = ('a, 'b, c_layout) Genarray.t (** The default type is Bigarray's Genarray. *) @@ -16,9 +16,9 @@ type side = Owl_cblas_basic.cblas_side type uplo = Owl_cblas_basic.cblas_uplo (** Side type *) -(** {6 Level-1 BLAS: vector-vector operations} *) +(** {5 Level-1 BLAS: vector-vector operations} *) -(** {6 Level-2 BLAS: matrix-vector operations} *) +(** {5 Level-2 BLAS: matrix-vector operations} *) val gemv : ?trans:bool @@ -46,7 +46,7 @@ val gbmv -> unit (** Computes a matrix-vector product using a general band matrix *) -(** {6 Level-3 BLAS: matrix-matrix operations} *) +(** {5 Level-3 BLAS: matrix-matrix operations} *) val gemm : ?transa:bool diff --git a/src/owl/cblas/owl_cblas_basic.mli b/src/owl/cblas/owl_cblas_basic.mli index a256be2ac..196904b81 100644 --- a/src/owl/cblas/owl_cblas_basic.mli +++ b/src/owl/cblas/owl_cblas_basic.mli @@ -13,7 +13,7 @@ open Bigarray -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t = ('a, 'b, Bigarray.c_layout) Bigarray.Array1.t (** The default type is Bigarray's ``Array1.t``. *) @@ -39,7 +39,7 @@ type cblas_side = | CblasLeft | CblasRight (** Side type *) -(** {6 Level-1 BLAS: vector-vector operations} *) +(** {5 Level-1 BLAS: vector-vector operations} *) val rotg : float -> float -> float * float * float * float (** Computes the parameters for a Givens rotation. *) @@ -101,7 +101,7 @@ val asum : int -> ('a, 'b) t -> int -> float val amax : int -> ('a, 'b) t -> int -> int (** Finds the index of the element with maximum absolute value. *) -(** {6 Level-2 BLAS: matrix-vector operations} *) +(** {5 Level-2 BLAS: matrix-vector operations} *) val gemv : cblas_layout @@ -424,7 +424,7 @@ val hpr2 -> unit (** Performs a rank-2 update of a Hermitian packed matrix. *) -(** {6 Level-3 BLAS: matrix-matrix operations} *) +(** {5 Level-3 BLAS: matrix-matrix operations} *) val gemm : cblas_layout diff --git a/src/owl/dense/owl_dense_matrix_generic.mli b/src/owl/dense/owl_dense_matrix_generic.mli index e6a26c053..021ff7c6c 100644 --- a/src/owl/dense/owl_dense_matrix_generic.mli +++ b/src/owl/dense/owl_dense_matrix_generic.mli @@ -26,14 +26,14 @@ open Bigarray open Owl_types open Owl_dense_ndarray_generic -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t = ('a, 'b, c_layout) Genarray.t (** N-dimensional array type, i.e. Bigarray Genarray type. *) -(** {6 Create matrices} *) +(** {5 Create matrices} *) val empty : ('a, 'b) kind -> int -> int -> ('a, 'b) t (** @@ -259,7 +259,7 @@ There are three different algorithms to deal with ``n`` is odd, singly even, and doubly even respectively. *) -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : ('a, 'b) t -> int * int (** @@ -311,7 +311,7 @@ val kind : ('a, 'b) t -> ('a, 'b) kind ``kind x`` returns the type of matrix ``x``. *) -(** {6 Manipulate a matrix} *) +(** {5 Manipulate a matrix} *) val get : ('a, 'b) t -> int -> int -> 'a (** @@ -619,7 +619,7 @@ increasing order. Note that the returned index ndarray has the same shape as that of ``x``, and the indices are 1D indices. *) -(**{6 Iteration functions} *) +(** {5 Iteration functions} *) val iteri : (int -> 'a -> unit) -> ('a, 'b) t -> unit (** @@ -875,7 +875,7 @@ val map_at_col : ('a -> 'a) -> ('a, 'b) t -> int -> ('a, 'b) t of an element is not passed to ``f``. *) -(** {6 Examination & Comparison} *) +(** {5 Examination & Comparison} *) val exists : ('a -> bool) -> ('a, 'b) t -> bool (** @@ -1143,7 +1143,7 @@ ndarray/matrix wherein ``1`` indicates that the element ``b`` from ``x`` is considered as approximately equal to ``a``, namely ``abs (a - b) < eps``. *) -(** {6 Randomisation functions} *) +(** {5 Randomisation functions} *) val draw_rows : ?replacement:bool -> ('a, 'b) t -> int -> ('a, 'b) t * int array (** @@ -1195,7 +1195,7 @@ val shuffle : ('a, 'b) t -> ('a, 'b) t rows then shuffling along columns. It is equivalent to ``shuffle_cols (shuffle_rows x)``. *) -(** {6 Input/Output functions} *) +(** {5 Input/Output functions} *) val to_array : ('a, 'b) t -> 'a array (** @@ -1284,7 +1284,7 @@ in the file is not of type ``k``, fails with ``[file]: incorrect format``. This function is implemented using npy-ocaml https://github.com/LaurentMazare/npy-ocaml. *) -(** {6 Unary math operators} *) +(** {5 Unary math operators} *) val re_c2s : (Complex.t, complex32_elt) t -> (float, float32_elt) t (** @@ -1964,7 +1964,7 @@ val jv_scalar : v:('a, 'b) t -> 'a -> ('a, 'b) t ``jv_scalar v x`` computes Bessel function of the first kind of ``x`` of real order ``v`` *) -(** {6 Binary math operators} *) +(** {5 Binary math operators} *) val add : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t (** @@ -2166,7 +2166,7 @@ between the elements of ``a`` and the matrix ``b``. val fma : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t (** ``fma x y z`` calculates the `fused multiply add`, i.e. ``(x * y) + z``. *) -(** {6 Cast functions} *) +(** {5 Cast functions} *) val cast : ('a, 'b) kind -> ('c, 'd) t -> ('a, 'b) t (** @@ -2215,7 +2215,7 @@ val cast_d2c : (float, float64_elt) t -> (Complex.t, complex32_elt) t ``cast_d2c x`` casts ``x`` from ``float64`` to ``complex32``. *) -(** {6 In-place modification} *) +(** {5 In-place modification} *) val create_ : out:('a, 'b) t -> 'a -> unit (** TODO *) diff --git a/src/owl/dense/owl_dense_matrix_intf.ml b/src/owl/dense/owl_dense_matrix_intf.ml index 9c0407234..28900ccdf 100644 --- a/src/owl/dense/owl_dense_matrix_intf.ml +++ b/src/owl/dense/owl_dense_matrix_intf.ml @@ -6,7 +6,7 @@ module type Common = sig type mat - (** {6 Create dense matrices} *) + (** {5 Create dense matrices} *) val empty : int -> int -> mat @@ -50,7 +50,7 @@ module type Common = sig val magic : int -> mat - (** {7 Dense row vectors and meshgrids} *) + (** {5 Dense row vectors and meshgrids} *) val vector : int -> mat @@ -68,7 +68,7 @@ module type Common = sig val meshup : mat -> mat -> mat * mat - (** {6 Obtain the basic properties of a matrix} *) + (** {5 Obtain the basic properties of a matrix} *) val shape : mat -> int * int @@ -88,7 +88,7 @@ module type Common = sig val same_data : mat -> mat -> bool - (** {6 Manipulate a matrix} *) + (** {5 Manipulate a matrix} *) val get : mat -> int -> int -> elt @@ -174,7 +174,7 @@ module type Common = sig val argsort : mat -> (int64, int64_elt, c_layout) Genarray.t - (** {6 Iterate elements, columns, and rows.} *) + (** {5 Iterate elements, columns, and rows.} *) val iteri : (int -> elt -> unit) -> mat -> unit @@ -266,7 +266,7 @@ module type Common = sig val map_at_col : (elt -> elt) -> mat -> int -> mat - (** {6 Examine elements and compare two matrices} *) + (** {5 Examine elements and compare two matrices} *) val exists : (elt -> bool) -> mat -> bool @@ -346,7 +346,7 @@ module type Common = sig val approx_elt_equal_scalar : ?eps:float -> mat -> elt -> mat - (** {6 Randomisation functions} *) + (** {5 Randomisation functions} *) val draw_rows : ?replacement:bool -> mat -> int -> mat * int array @@ -362,7 +362,7 @@ module type Common = sig val shuffle : mat -> mat - (** {6 Input/Output and helper functions} *) + (** {5 Input/Output and helper functions} *) val to_array : mat -> elt array @@ -400,7 +400,7 @@ module type Common = sig val load_npy : string -> mat - (** {6 Unary mathematical operations } *) + (** {5 Unary mathematical operations } *) val min : ?axis:int -> ?keep_dims:bool -> mat -> mat @@ -560,7 +560,7 @@ module type Common = sig val dawsn : mat -> mat - (** {6 Binary mathematical operations } *) + (** {5 Binary mathematical operations } *) val add : mat -> mat -> mat @@ -612,7 +612,7 @@ module type Common = sig val fma : mat -> mat -> mat -> mat - (** {6 Functions of in-place modification } *) + (** {5 Functions of in-place modification } *) val create_ : out:mat -> elt -> unit @@ -820,7 +820,7 @@ module type Real = sig type mat - (** {6 Specific real functions } *) + (** {5 Specific real functions } *) val i0 : mat -> mat @@ -912,7 +912,7 @@ module type Complex = sig type cast_mat - (** {6 Specific complex functions } *) + (** {5 Specific complex functions } *) val complex : cast_mat -> cast_mat -> mat diff --git a/src/owl/dense/owl_dense_ndarray_a.mli b/src/owl/dense/owl_dense_ndarray_a.mli index bfb1306eb..a0ef29bac 100644 --- a/src/owl/dense/owl_dense_ndarray_a.mli +++ b/src/owl/dense/owl_dense_ndarray_a.mli @@ -11,7 +11,7 @@ type 'a arr = ; mutable data : 'a array } -(** {6 Create N-dimensional array} *) +(** {5 Create N-dimensional array} *) val create : int array -> 'a -> 'a arr @@ -25,7 +25,7 @@ val zeros : int array -> float arr val ones : int array -> float arr -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : 'a arr -> int array @@ -45,7 +45,7 @@ val index_1d_nd : int -> int array -> int array val index_nd_1d : int array -> int array -> int -(** {6 Manipulate a N-dimensional array} *) +(** {5 Manipulate a N-dimensional array} *) val get : 'a arr -> int array -> 'a @@ -93,7 +93,7 @@ val concatenate : ?axis:int -> 'a arr array -> 'a arr val pad : 'a -> int list list -> 'a arr -> 'a arr -(** {6 Iterate array elements} *) +(** {5 Iterate array elements} *) val iter : ('a -> unit) -> 'a arr -> unit @@ -119,7 +119,7 @@ val map2 : ('a -> 'b -> 'c) -> 'a arr -> 'b arr -> 'c arr val map2i : (int -> 'a -> 'b -> 'c) -> 'a arr -> 'b arr -> 'c arr -(** {6 Examine array elements or compare two arrays } *) +(** {5 Examine array elements or compare two arrays } *) val exists : ('a -> bool) -> 'a arr -> bool @@ -173,7 +173,7 @@ val min_i : ?cmp:('a -> 'a -> int) -> 'a arr -> 'a * int val max_i : ?cmp:('a -> 'a -> int) -> 'a arr -> 'a * int -(** {6 Input/Output functions} *) +(** {5 Input/Output functions} *) val of_array : 'a array -> int array -> 'a arr diff --git a/src/owl/dense/owl_dense_ndarray_generic.mli b/src/owl/dense/owl_dense_ndarray_generic.mli index e03a0a90d..80cb13bc9 100644 --- a/src/owl/dense/owl_dense_ndarray_generic.mli +++ b/src/owl/dense/owl_dense_ndarray_generic.mli @@ -25,7 +25,7 @@ Float32, Float64, Complex32, Complex64. open Bigarray open Owl_types -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t = ('a, 'b, c_layout) Genarray.t (** @@ -37,7 +37,7 @@ type ('a, 'b) kind = ('a, 'b) Bigarray.kind Type of the ndarray, e.g., Bigarray.Float32, Bigarray.Complex64, and etc. *) -(** {6 Create Ndarrays} *) +(** {5 Create Ndarrays} *) val empty : ('a, 'b) kind -> int array -> ('a, 'b) t (** @@ -158,7 +158,7 @@ val unit_basis : ('a, 'b) kind -> int -> int -> ('a, 'b) t ``unit_basis k n i`` returns a unit basis vector with ``i``th element set to 1. *) -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : ('a, 'b) t -> int array (** @@ -239,7 +239,7 @@ val i1d : ('a, 'b) t -> int array -> int ``i1d x i`` converts ``x``'s n-dimensional index ``i`` to one-dimensional one. *) -(** {6 Manipulate Ndarrays} *) +(** {5 Manipulate Ndarrays} *) val get : ('a, 'b) t -> int array -> 'a (** @@ -626,7 +626,7 @@ val mmap ``mmap fd kind layout shared dims`` ... *) -(** {6 Iteration functions} *) +(** {5 Iteration functions} *) val iteri : (int -> 'a -> unit) -> ('a, 'b) t -> unit (** @@ -790,7 +790,7 @@ Please refer to ``iteri_slice`` for more details. val fold_slice : ?axis:int -> ('c -> ('a, 'b) t -> 'c) -> 'c -> ('a, 'b) t -> 'c (** Similar to ``foldi_slice`` but slice index is not passed in. *) -(** {6 Examination & Comparison} *) +(** {5 Examination & Comparison} *) val exists : ('a -> bool) -> ('a, 'b) t -> bool (** @@ -1072,7 +1072,7 @@ ndarray/matrix wherein ``1`` indicates that the element ``b`` from ``x`` is considered as approximately equal to ``a``, namely ``abs (a - b) < eps``. *) -(** {6 Input/Output functions} *) +(** {5 Input/Output functions} *) val of_array : ('a, 'b) kind -> 'a array -> int array -> ('a, 'b) t (** @@ -1131,7 +1131,7 @@ in the file is not of type ``k``, fails with ``[file]: incorrect format``. This function is implemented using npy-ocaml https://github.com/LaurentMazare/npy-ocaml. *) -(** {6 Unary math operators } *) +(** {5 Unary math operators } *) val re_c2s : (Complex.t, complex32_elt) t -> (float, float32_elt) t (** @@ -1788,7 +1788,7 @@ val jv_scalar : v:('a, 'b) t -> 'a -> ('a, 'b) t ``jv_scalar v x`` computes Bessel function of the first kind of ``x`` of real order ``v`` *) -(** {6 Binary math operators} *) +(** {5 Binary math operators} *) val add : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t (** @@ -1966,7 +1966,7 @@ val clip_by_l2norm : 'a -> ('a, 'b) t -> ('a, 'b) t val fma : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t (** ``fma x y z`` calculates the `fused multiply add`, i.e. ``(x * y) + z``. *) -(** {6 Tensor Calculus} *) +(** {5 Tensor Calculus} *) val contract1 : (int * int) array -> ('a, 'b) t -> ('a, 'b) t (** @@ -1988,7 +1988,7 @@ Caveat: Not well tested yet, use with care! Also, consider to use TTGT in future for better performance. *) -(** {6 Cast functions} *) +(** {5 Cast functions} *) val cast : ('a, 'b) kind -> ('c, 'd) t -> ('a, 'b) t (** @@ -2037,7 +2037,7 @@ val cast_d2c : (float, float64_elt) t -> (Complex.t, complex32_elt) t ``cast_d2c x`` casts ``x`` from ``float64`` to ``complex32``. *) -(** {6 Neural network related} *) +(** {5 Neural network related} *) val conv1d : ?padding:padding -> ('a, 'b) t -> ('a, 'b) t -> int array -> ('a, 'b) t (** TODO *) @@ -2335,7 +2335,7 @@ val avg_pool3d_backward val upsampling2d_backward : ('a, 'b) t -> int array -> ('a, 'b) t -> ('a, 'b) t (** TODO *) -(** {6 Helper functions } *) +(** {5 Helper functions } *) (** The following functions are helper functions for some other functions in @@ -2387,7 +2387,7 @@ Parameters: * ``window`` is the size of the sliding window. *) -(** {6 In-place modification} *) +(** {5 In-place modification} *) val create_ : out:('a, 'b) t -> 'a -> unit (** TODO *) @@ -3323,7 +3323,7 @@ val upsampling2d_backward_ val fused_adagrad_ : ?out:('a, 'b) t -> rate:'a -> eps:'a -> ('a, 'b) t -> unit (** TODO *) -(** {6 Matrix functions} *) +(** {5 Matrix functions} *) type area = { a : int @@ -3412,7 +3412,7 @@ val draw_cols2 -> ('a, 'b) t * ('a, 'b) t * int array (** Refer to :doc:`owl_dense_matrix_generic` *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val float_to_elt : 'a -> 'a (** Identity function to deal with the type conversion required by other functors. *) diff --git a/src/owl/dense/owl_dense_ndarray_intf.ml b/src/owl/dense/owl_dense_ndarray_intf.ml index 4b38f60dc..88491e795 100644 --- a/src/owl/dense/owl_dense_ndarray_intf.ml +++ b/src/owl/dense/owl_dense_ndarray_intf.ml @@ -12,7 +12,7 @@ module type Common = sig (* NOTE: below are all the functions that have not been implemented in Base*) - (** {6 Create N-dimensional array} *) + (** {5 Create N-dimensional array} *) val linspace : elt -> elt -> int -> arr (** @@ -29,7 +29,7 @@ module type Common = sig ``unit_basis k n i`` returns a unit basis vector with ``i``th element set to 1. *) - (** {6 Obtain basic properties} *) + (** {5 Obtain basic properties} *) val num_dims : arr -> int @@ -49,7 +49,7 @@ module type Common = sig val i1d : arr -> int array -> int - (** {6 Manipulate a N-dimensional array} *) + (** {5 Manipulate a N-dimensional array} *) val get_index : arr -> int array array -> elt array @@ -97,7 +97,7 @@ module type Common = sig val mmap : Unix.file_descr -> ?pos:int64 -> bool -> int array -> arr - (** {6 Iterate array elements} *) + (** {5 Iterate array elements} *) val iter2i : (int -> elt -> elt -> unit) -> arr -> arr -> unit @@ -137,7 +137,7 @@ module type Common = sig val fold_slice : ?axis:int -> ('c -> arr -> 'c) -> 'c -> arr -> 'c - (** {6 Examine array elements or compare two arrays } *) + (** {5 Examine array elements or compare two arrays } *) val approx_equal : ?eps:float -> arr -> arr -> bool @@ -147,7 +147,7 @@ module type Common = sig val approx_elt_equal_scalar : ?eps:float -> arr -> elt -> arr - (** {6 Input/Output functions} *) + (** {5 Input/Output functions} *) val to_array : arr -> elt array @@ -159,7 +159,7 @@ module type Common = sig val load_npy : string -> arr - (** {6 Unary mathematical operations } *) + (** {5 Unary mathematical operations } *) val prod : ?axis:int -> ?keep_dims:bool -> arr -> arr @@ -247,7 +247,7 @@ module type Common = sig val lgamma : arr -> arr - (** {6 Binary mathematical operations } *) + (** {5 Binary mathematical operations } *) val min2 : arr -> arr -> arr @@ -261,19 +261,19 @@ module type Common = sig val clip_by_l2norm : elt -> arr -> arr - (** {6 Tensor Calculus} *) + (** {5 Tensor Calculus} *) val contract1 : (int * int) array -> arr -> arr val contract2 : (int * int) array -> arr -> arr -> arr - (** {6 Experimental functions} *) + (** {5 Experimental functions} *) val sum_slices : ?axis:int -> arr -> arr val slide : ?axis:int -> ?ofs:int -> ?step:int -> window:int -> arr -> arr - (** {6 Functions of in-place modification } *) + (** {5 Functions of in-place modification } *) val create_ : out:arr -> elt -> unit @@ -496,7 +496,7 @@ module type Common = sig val elt_less_equal_scalar_ : ?out:arr -> arr -> elt -> unit val elt_greater_equal_scalar_ : ?out:arr -> arr -> elt -> unit - (** {6 Matrix functions} *) + (** {5 Matrix functions} *) val col : arr -> int -> arr @@ -523,7 +523,7 @@ module type Real = sig (* NOTE: below are all the functions that have not been implemented in Base*) - (** {6 Real operations} *) + (** {5 Real operations} *) val i0 : arr -> arr @@ -599,7 +599,7 @@ module type Complex = sig type cast_arr - (** {6 Complex operations} *) + (** {5 Complex operations} *) val complex : cast_arr -> cast_arr -> arr (** @@ -629,7 +629,7 @@ end module type Distribution = sig type arr - (** {6 Stats & distribution functions} *) + (** {5 Stats & distribution functions} *) val uniform_rvs : a:arr -> b:arr -> n:int -> arr @@ -926,7 +926,7 @@ module type NN = sig (* NOTE: below are all the functions that have not been implemented in Base*) - (** {6 Neural network related functions} *) + (** {5 Neural network related functions} *) val max_pool2d_argmax : ?padding:padding diff --git a/src/owl/fftpack/owl_fft_generic.mli b/src/owl/fftpack/owl_fft_generic.mli index 789bfcb48..44f4fb608 100644 --- a/src/owl/fftpack/owl_fft_generic.mli +++ b/src/owl/fftpack/owl_fft_generic.mli @@ -7,7 +7,7 @@ open Owl_dense_ndarray_generic -(** {6 Basic functions} *) +(** {5 Basic functions} *) val fft : ?axis:int -> (Complex.t, 'a) t -> (Complex.t, 'a) t (** diff --git a/src/owl/lapacke/owl_lapacke.mli b/src/owl/lapacke/owl_lapacke.mli index d66a62be3..ac334d9d2 100644 --- a/src/owl/lapacke/owl_lapacke.mli +++ b/src/owl/lapacke/owl_lapacke.mli @@ -5,7 +5,7 @@ open Bigarray -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t = ('a, 'b, c_layout) Genarray.t (** Default data type *) @@ -31,7 +31,7 @@ type lapacke_side = | Left | Right (** Side type. *) -(** {6 Basic functions} *) +(** {5 Basic functions} *) val gbtrs : trans:lapacke_transpose diff --git a/src/owl/linalg/owl_linalg_generic.mli b/src/owl/linalg/owl_linalg_generic.mli index a6db48742..dae507012 100644 --- a/src/owl/linalg/owl_linalg_generic.mli +++ b/src/owl/linalg/owl_linalg_generic.mli @@ -18,14 +18,14 @@ open Bigarray -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t = ('a, 'b) Owl_dense_matrix_generic.t (** Matrix type, a special case of N-dimensional array. *) -(** {6 Basic functions} *) +(** {5 Basic functions} *) val inv : ('a, 'b) t -> ('a, 'b) t (** @@ -116,7 +116,7 @@ If ``x`` is well conditioned, the returned result is near ``1.0``. If ``x`` is b conditioned, the result is near ``0.`` *) -(** {6 Check matrix types} *) +(** {5 Check matrix types} *) val is_square : ('a, 'b) t -> bool (** ``is_square x`` returns ``true`` if ``x`` is a square matrix otherwise ``false``. *) @@ -139,7 +139,7 @@ val is_diag : ('a, 'b) t -> bool val is_posdef : ('a, 'b) t -> bool (** ``is_posdef x`` checks whether ``x`` is a positive semi-definite matrix. *) -(** {6 Factorisation} *) +(** {5 Factorisation} *) val lu : ('a, 'b) t -> ('a, 'b) t * ('a, 'b) t * (int32, int32_elt) t (** @@ -336,7 +336,7 @@ Both Hessenberg matrix ``h`` and unitary matrix ``q`` is returned, such that *) -(** {6 Eigenvalues & eigenvectors} *) +(** {5 Eigenvalues & eigenvectors} *) val eig : ?permute:bool @@ -365,7 +365,7 @@ val eigvals an arbitrary square matrix ``x``. *) -(** {6 Linear system of equations} *) +(** {5 Linear system of equations} *) val null : ('a, 'b) t -> ('a, 'b) t (** @@ -533,7 +533,7 @@ Returns: * ``x`` : a symmetric solution matrix X. *) -(** {6 Low-level factorisation functions} *) +(** {5 Low-level factorisation functions} *) val lufact : ('a, 'b) t -> ('a, 'b) t * (int32, int32_elt) t (** @@ -570,7 +570,7 @@ structure of ``d``. Please refer to the function ``sytrf``, ``hetrf`` in MKL documentation for more details. *) -(** {6 Matrix functions} *) +(** {5 Matrix functions} *) val mpow : ('a, 'b) t -> float -> ('a, 'b) t (** @@ -639,7 +639,7 @@ val sinhcoshm : ('a, 'b) t -> ('a, 'b) t * ('a, 'b) t ``sinhcoshm x`` returns both hyperbolic matrix sine and cosine of ``x``. *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val select_ev : [ `LHP | `RHP | `UDI | `UDO ] -> ('a, 'b) t -> (int32, int32_elt) t (** diff --git a/src/owl/linalg/owl_linalg_intf.ml b/src/owl/linalg/owl_linalg_intf.ml index e1a3f6f24..2870f3ffd 100644 --- a/src/owl/linalg/owl_linalg_intf.ml +++ b/src/owl/linalg/owl_linalg_intf.ml @@ -8,7 +8,7 @@ module type Common = sig (* NOTE: functions below have not been implemented in Base Linalg *) - (** {6 Basic functions} *) + (** {5 Basic functions} *) val pinv : ?tol:float -> mat -> mat @@ -24,7 +24,7 @@ module type Common = sig val is_posdef : mat -> bool - (** {6 Factorisation} *) + (** {5 Factorisation} *) val lu : mat -> mat * mat * int32_mat @@ -54,13 +54,13 @@ module type Common = sig val hess : mat -> mat * mat - (** {6 Eigenvalues & eigenvectors} *) + (** {5 Eigenvalues & eigenvectors} *) val eig : ?permute:bool -> ?scale:bool -> mat -> complex_mat * complex_mat val eigvals : ?permute:bool -> ?scale:bool -> mat -> complex_mat - (** {6 Linear system of equations} *) + (** {5 Linear system of equations} *) val null : mat -> mat @@ -68,7 +68,7 @@ module type Common = sig val linreg : mat -> mat -> elt * elt - (** {6 Low-level factorisation functions} *) + (** {5 Low-level factorisation functions} *) val lufact : mat -> mat * int32_mat @@ -76,7 +76,7 @@ module type Common = sig val bkfact : ?upper:bool -> ?symmetric:bool -> ?rook:bool -> mat -> mat * int32_mat - (** {6 Matrix functions} *) + (** {5 Matrix functions} *) val mpow : mat -> float -> mat @@ -100,7 +100,7 @@ module type Common = sig val sinhcoshm : mat -> mat * mat - (** {6 Helper functions} *) + (** {5 Helper functions} *) val select_ev : [ `LHP | `RHP | `UDI | `UDO ] -> mat -> int32_mat diff --git a/src/owl/maths/owl_maths.mli b/src/owl/maths/owl_maths.mli index 13896f827..e609e4a32 100644 --- a/src/owl/maths/owl_maths.mli +++ b/src/owl/maths/owl_maths.mli @@ -12,7 +12,7 @@ Please refer to Scipy documentation. *) -(** {6 Basic functions} *) +(** {5 Basic functions} *) val add : float -> float -> float (** ``add x y`` returns :math:`x + y`. *) @@ -224,7 +224,7 @@ val log1mexp : float -> float val log1pexp : float -> float (** ``log1pexp(x)`` returns :math:`log(1+exp(x))`. *) -(** {6 Airy functions} *) +(** {5 Airy functions} *) val airy : float -> float * float * float * float (** @@ -232,7 +232,7 @@ Airy function ``airy x`` returns ``(Ai, Ai', Bi, Bi')`` evaluated at :math:`x`. ``Ai'`` is the derivative of ``Ai`` whilst ``Bi'`` is the derivative of ``Bi``. *) -(** {6 Bessel functions} *) +(** {5 Bessel functions} *) val j0 : float -> float (** Bessel function of the first kind of order 0. *) @@ -282,7 +282,7 @@ val k1 : float -> float val k1e : float -> float (** Exponentially scaled modified Bessel function K of order 1. *) -(** {6 Elliptic functions} *) +(** {5 Elliptic functions} *) val ellipj : float -> float -> float * float * float * float (** Jacobian Elliptic function ``ellipj u m`` returns ``(sn, cn, dn, phi)``. *) @@ -302,7 +302,7 @@ val ellipe : float -> float val ellipeinc : float -> float -> float (** ``ellipeinc phi m`` incomplete elliptic integral of the second kind. *) -(** {6 Gamma Functions} *) +(** {5 Gamma Functions} *) val gamma : float -> float (** @@ -337,7 +337,7 @@ val gammainccinv : float -> float -> float val psi : float -> float (** The digamma function. *) -(** {6 Beta functions} *) +(** {5 Beta functions} *) val beta : float -> float -> float (** @@ -353,7 +353,7 @@ val betainc : float -> float -> float -> float val betaincinv : float -> float -> float -> float (** Inverse function of ``betainc``. *) -(** {6 Factorials} *) +(** {5 Factorials} *) val fact : int -> float (** Factorial function ``fact n`` calculates :math:`n!`. *) @@ -388,7 +388,7 @@ val combination_float : int -> int -> float val log_combination : int -> int -> float (** ``log_combination n k`` returns the logarithm of :math:`\binom{n}{k}`. *) -(** {6 Error functions} *) +(** {5 Error functions} *) val erf : float -> float (** Error function. :math:`\int_{-\infty}^x \frac{1}{\sqrt(2\pi)} \exp(-(1/2) y^2) dy` *) @@ -405,7 +405,7 @@ val erfinv : float -> float val erfcinv : float -> float (** Inverse function of ``erfc``. *) -(** {6 Dawson & Fresnel integrals} *) +(** {5 Dawson & Fresnel integrals} *) val dawsn : float -> float (** Dawson’s integral. *) @@ -414,7 +414,7 @@ val fresnel : float -> float * float (** Fresnel trigonometric integrals. ``fresnel x`` returns a tuple consisting of ``(Fresnel sin integral, Fresnel cos integral)``. *) -(** {6 Struve functions} *) +(** {5 Struve functions} *) val struve : float -> float -> float (** ``struve v x`` returns the value of the Struve function of @@ -427,7 +427,7 @@ where :math:`\Gamma` is the gamma function. :math:`x` must be positive unless :m *) -(** {6 Other special functions} *) +(** {5 Other special functions} *) val expn : int -> float -> float (** Exponential integral :math:`E_n`. *) @@ -458,7 +458,7 @@ val zeta : float -> float -> float val zetac : float -> float (** Riemann zeta function minus 1. *) -(** {6 Raw statistical functions} *) +(** {5 Raw statistical functions} *) val bdtr : int -> int -> float -> float (** @@ -545,7 +545,7 @@ Returns: * The quantile corresponding to :math:`p`. *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val is_nan : float -> bool (** ``is_nan x`` returns ``true`` exactly if ``x`` is ``nan``. *) diff --git a/src/owl/neural/owl_neural.ml b/src/owl/neural/owl_neural.ml index 5e712c9e4..a2e647fa9 100644 --- a/src/owl/neural/owl_neural.ml +++ b/src/owl/neural/owl_neural.ml @@ -3,7 +3,7 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Single precision neural network} *) +(** {5 Single precision neural network} *) module S = struct include Owl_neural_generic.Make (Owl_algodiff_primal_ops.S) @@ -11,7 +11,7 @@ module S = struct (* module Parallel = Owl_neural_parallel.Make (Graph) *) end -(** {6 Double precision neural network} *) +(** {5 Double precision neural network} *) module D = struct include Owl_neural_generic.Make (Owl_algodiff_primal_ops.D) diff --git a/src/owl/nlp/owl_nlp_corpus.mli b/src/owl/nlp/owl_nlp_corpus.mli index bb1656567..3ff07be4d 100644 --- a/src/owl/nlp/owl_nlp_corpus.mli +++ b/src/owl/nlp/owl_nlp_corpus.mli @@ -5,12 +5,12 @@ (** NLP: Corpus module *) -(** {6 Type definition} *) +(** {5 Type definition} *) type t (** Type of a text corpus. *) -(** {6 Query corpus} *) +(** {5 Query corpus} *) val length : t -> int (** Return the size of the corpus, i.e. number of documents. *) @@ -45,7 +45,7 @@ val get_vocab : t -> Owl_nlp_vocabulary.t val get_docid : t -> int array (** Return a list of document ids which are mapped back to the original file where the corpus is built. *) -(** {6 Iteration functions} *) +(** {5 Iteration functions} *) val next : t -> string (** Return the next document in the corpus. *) @@ -74,7 +74,7 @@ val next_batch_tok : ?size:int -> t -> int array array val reset_iterators : t -> unit (** Reset the iterator to the beginning of the corpus. *) -(** {6 Core functions} *) +(** {5 Core functions} *) val build : ?docid:int array @@ -118,7 +118,7 @@ E.g., you can plug in ``simple_process`` function to clean up the text. Note this function will not change the number of lines in a corpus. *) -(** {6 I/O functions} *) +(** {5 I/O functions} *) val save : t -> string -> unit (** Serialise the corpus and save it to a file of given name. *) @@ -135,7 +135,7 @@ val to_string : t -> string val print : t -> unit (** Pretty print the summary of a text corpus. *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val create : string diff --git a/src/owl/nlp/owl_nlp_lda.mli b/src/owl/nlp/owl_nlp_lda.mli index ec6068a75..ce1294926 100644 --- a/src/owl/nlp/owl_nlp_lda.mli +++ b/src/owl/nlp/owl_nlp_lda.mli @@ -5,7 +5,7 @@ (** NLP: LDA module *) -(** {6 Type definition} *) +(** {5 Type definition} *) type lda_typ = | SimpleLDA @@ -16,7 +16,7 @@ type lda_typ = type model (** Type of LDA model. *) -(** {6 Core functions} *) +(** {5 Core functions} *) val init : ?iter:int -> int -> Owl_nlp_corpus.t -> model (** @@ -32,7 +32,7 @@ Parameters: val train : lda_typ -> model -> unit (** After calling ``init``, calling this function starts the training. *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val show_info : model -> int -> float -> unit (** Function for printing out log information, tailored for LDA training. *) diff --git a/src/owl/nlp/owl_nlp_tfidf.mli b/src/owl/nlp/owl_nlp_tfidf.mli index c5fbb9520..971b98b41 100644 --- a/src/owl/nlp/owl_nlp_tfidf.mli +++ b/src/owl/nlp/owl_nlp_tfidf.mli @@ -5,7 +5,7 @@ (** NLP: TFIDF module *) -(** {6 Type definition} *) +(** {5 Type definition} *) type tf_typ = | Binary @@ -21,7 +21,7 @@ type df_typ = type t (** Type of a TFIDF model *) -(** {6 Query model} *) +(** {5 Query model} *) val length : t -> int (** Size of Tfidf model, i.e. number of documents contained. *) @@ -63,7 +63,7 @@ val doc_to_vec -> (float, 'a) Owl_dense.Ndarray.Generic.t (** ``doc_to_vec kind tfidf vec`` converts a TFIDF vector from its sparse represents to dense ndarray vector whose length equals the vocabulary size. *) -(** {6 Iteration functions} *) +(** {5 Iteration functions} *) val get : t -> int -> (int * float) array (** Return the ith TFIDF vector in the model. The format of return is ``(vocabulary index, weight)`` tuple array of a document. *) @@ -83,7 +83,7 @@ val mapi : (int -> (int * float) array -> 'a) -> t -> 'a array val reset_iterators : t -> unit (** Reset the iterator to the beginning of the TFIDF model. *) -(** {6 Core functions} *) +(** {5 Core functions} *) val build : ?norm:bool -> ?sort:bool -> ?tf:tf_typ -> ?df:df_typ -> Owl_nlp_corpus.t -> t (** @@ -97,7 +97,7 @@ Parameters: * ``corpus``: the corpus built by ``Owl_nlp_corpus`` model atop of which TFIDF will be built. *) -(** {6 I/O functions} *) +(** {5 I/O functions} *) val save : t -> string -> unit (** ``save tfidf fname`` saves the TFIDF to a file of given file name ``fname``. *) @@ -111,7 +111,7 @@ val to_string : t -> string val print : t -> unit (** Pretty print out the summary information of a TFIDF model. *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val tf_typ_string : tf_typ -> string (** Convert term frequency type into string. *) diff --git a/src/owl/nlp/owl_nlp_vocabulary.mli b/src/owl/nlp/owl_nlp_vocabulary.mli index dd5fe347a..a8c19612b 100644 --- a/src/owl/nlp/owl_nlp_vocabulary.mli +++ b/src/owl/nlp/owl_nlp_vocabulary.mli @@ -5,12 +5,12 @@ (** NLP: Vocabulary module *) -(** {6 Type definition} *) +(** {5 Type definition} *) type t (** Type of vocabulary (or dictionary). *) -(** {6 Query vocabulary} *) +(** {5 Query vocabulary} *) val get_w2i : t -> (string, int) Hashtbl.t (** ``get_w2i v`` returns word -> index mapping of ``v``. *) @@ -30,7 +30,7 @@ val word2index : t -> string -> int val index2word : t -> int -> string (** ``index2word v i`` converts index ``i`` to its corresponding word using vocabulary ``v``. *) -(** {6 Obtain properties} *) +(** {5 Obtain properties} *) val length : t -> int (** ``length v`` returns the size of vocabulary ``v``. *) @@ -56,7 +56,7 @@ val bottom : t -> int -> (string * int) array val re_index : t -> t (** ``re_index v`` re-indexes the indices of words in vocabulary ``v``. *) -(** {6 Core functions} *) +(** {5 Core functions} *) val build : ?lo:float @@ -128,7 +128,7 @@ val to_array : t -> (int * string) array val of_array : (int * string) array -> t (** ``of_array v`` converts a (index, word) array to a vocabulary. *) -(** {6 I/O functions} *) +(** {5 I/O functions} *) val save : t -> string -> unit (** ``save v fname`` serialises the vocabulary and saves it to a file of name ``s``. *) diff --git a/src/owl/optimise/owl_regression_generic_sig.ml b/src/owl/optimise/owl_regression_generic_sig.ml index 25339d365..fa53f19d2 100644 --- a/src/owl/optimise/owl_regression_generic_sig.ml +++ b/src/owl/optimise/owl_regression_generic_sig.ml @@ -8,7 +8,7 @@ module type Sig = sig open Optimise.Algodiff - (** {6 Type definition} *) + (** {5 Type definition} *) type arr = A.arr (** Type of ndarray values. *) @@ -16,7 +16,7 @@ module type Sig = sig type elt = A.elt (** Type of scalar values. *) - (** {6 Regression models} *) + (** {5 Regression models} *) val ols : ?i:bool -> arr -> arr -> arr array (** TODO *) diff --git a/src/owl/ppl/owl_distribution.mli b/src/owl/ppl/owl_distribution.mli index bbf647ca9..ff42bd458 100644 --- a/src/owl/ppl/owl_distribution.mli +++ b/src/owl/ppl/owl_distribution.mli @@ -6,7 +6,7 @@ (** Functor to generate distribution module *) module Make (A : Owl_types.Stats_Dist) : sig - (** {6 Uniform distribution} *) + (** {5 Uniform distribution} *) module Uniform : sig type t = @@ -46,7 +46,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Gaussian distribution} *) + (** {5 Gaussian distribution} *) module Gaussian : sig type t = @@ -86,7 +86,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Exponential distribution} *) + (** {5 Exponential distribution} *) module Exponential : sig type t = { lambda : A.arr } @@ -123,7 +123,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Poisson distribution} *) + (** {5 Poisson distribution} *) module Poisson : sig type t = { mu : A.arr } @@ -136,7 +136,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Sample a distribution of the given parameters. *) end - (** {6 Gamma distribution} *) + (** {5 Gamma distribution} *) module Gamma : sig type t = @@ -176,7 +176,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Beta distribution} *) + (** {5 Beta distribution} *) module Beta : sig type t = @@ -216,7 +216,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Chi2 distribution} *) + (** {5 Chi2 distribution} *) module Chi2 : sig type t = { df : A.arr } @@ -253,7 +253,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 F distribution} *) + (** {5 F distribution} *) module F : sig type t = @@ -293,7 +293,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Cauchy distribution} *) + (** {5 Cauchy distribution} *) module Cauchy : sig type t = @@ -333,7 +333,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Lomax distribution} *) + (** {5 Lomax distribution} *) module Lomax : sig type t = @@ -373,7 +373,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Weibull distribution} *) + (** {5 Weibull distribution} *) module Weibull : sig type t = @@ -413,7 +413,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Laplace distribution} *) + (** {5 Laplace distribution} *) module Laplace : sig type t = @@ -453,7 +453,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Gumbel1 distribution} *) + (** {5 Gumbel1 distribution} *) module Gumbel1 : sig type t = @@ -493,7 +493,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Gumbel2 distribution} *) + (** {5 Gumbel2 distribution} *) module Gumbel2 : sig type t = @@ -533,7 +533,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Logistic distribution} *) + (** {5 Logistic distribution} *) module Logistic : sig type t = @@ -573,7 +573,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Lognormal distribution} *) + (** {5 Lognormal distribution} *) module Lognormal : sig type t = @@ -613,7 +613,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Rayleigh distribution} *) + (** {5 Rayleigh distribution} *) module Rayleigh : sig type t = { sigma : A.arr } @@ -650,7 +650,7 @@ module Make (A : Owl_types.Stats_Dist) : sig (** Inverse survival function of the distribution. *) end - (** {6 Type definition} *) + (** {5 Type definition} *) type dist = | Uniform of Uniform.t @@ -670,7 +670,7 @@ module Make (A : Owl_types.Stats_Dist) : sig | Lognormal of Lognormal.t | Rayleigh of Rayleigh.t (** Type definition of various distributions *) - (** {6 Core functions} *) + (** {5 Core functions} *) val sample : dist -> int -> A.arr (** Sample a given distribution of the given parameters. *) diff --git a/src/owl/sparse/owl_sparse_dok_matrix.mli b/src/owl/sparse/owl_sparse_dok_matrix.mli index 988537bae..58d91a856 100644 --- a/src/owl/sparse/owl_sparse_dok_matrix.mli +++ b/src/owl/sparse/owl_sparse_dok_matrix.mli @@ -7,11 +7,11 @@ type ('a, 'b) t type ('a, 'b) kind = ('a, 'b) Bigarray.kind -(** {6 Create sparse matrices} *) +(** {5 Create sparse matrices} *) val zeros : ?density:float -> ('a, 'b) kind -> int -> int -> ('a, 'b) t -(** {6 Obtain the basic properties} *) +(** {5 Obtain the basic properties} *) val shape : ('a, 'b) t -> int * int @@ -27,7 +27,7 @@ val density : ('a, 'b) t -> float val kind : ('a, 'b) t -> ('a, 'b) kind -(** {6 Manipulate a matrix} *) +(** {5 Manipulate a matrix} *) val set : ('a, 'b) t -> int -> int -> 'a -> unit @@ -37,11 +37,11 @@ val reset : ('a, 'b) t -> unit val copy : ('a, 'b) t -> ('a, 'b) t -(** {6 Iterate elements, columns, and rows} *) +(** {5 Iterate elements, columns, and rows} *) val iteri_nz : (int -> int -> 'a -> unit) -> ('a, 'b) t -> unit -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val save : ('a, 'b) t -> string -> unit diff --git a/src/owl/sparse/owl_sparse_matrix_c.mli b/src/owl/sparse/owl_sparse_matrix_c.mli index 0c7a17472..42c3bf036 100644 --- a/src/owl/sparse/owl_sparse_matrix_c.mli +++ b/src/owl/sparse/owl_sparse_matrix_c.mli @@ -7,7 +7,7 @@ type elt = Complex.t type mat = (Complex.t, Bigarray.complex32_elt) Owl_sparse_matrix_generic.t -(** {6 Create sparse matrices} *) +(** {5 Create sparse matrices} *) val zeros : int -> int -> mat @@ -23,7 +23,7 @@ val uniform_int : ?a:int -> ?b:int -> int -> int -> mat val sequential : int -> int -> mat -(** {6 Obtain the basic properties of a matrix} *) +(** {5 Obtain the basic properties of a matrix} *) val shape : mat -> int * int @@ -45,7 +45,7 @@ val nnz_cols : mat -> int array val density : mat -> float -(** {6 Manipulate a matrix} *) +(** {5 Manipulate a matrix} *) val insert : mat -> int -> int -> elt -> unit @@ -73,7 +73,7 @@ val cols : mat -> int array -> mat val prune : mat -> elt -> float -> unit -(** {6 Iterate elements, columns, and rows} *) +(** {5 Iterate elements, columns, and rows} *) val iteri : (int -> int -> elt -> unit) -> mat -> unit @@ -147,7 +147,7 @@ val fold_rows_nz : ('a -> mat -> 'a) -> 'a -> mat -> 'a val fold_cols_nz : ('a -> mat -> 'a) -> 'a -> mat -> 'a -(** {6 Examine elements and compare two matrices} *) +(** {5 Examine elements and compare two matrices} *) val exists : (elt -> bool) -> mat -> bool @@ -181,7 +181,7 @@ val greater_equal : mat -> mat -> bool val less_equal : mat -> mat -> bool -(** {6 Randomisation functions} *) +(** {5 Randomisation functions} *) val permutation_matrix : int -> mat @@ -195,7 +195,7 @@ val shuffle_cols : mat -> mat val shuffle : mat -> mat -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : mat -> (int array * elt) array @@ -211,7 +211,7 @@ val save : mat -> string -> unit val load : string -> mat -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val trace : mat -> elt @@ -233,7 +233,7 @@ val neg : mat -> mat (* val l2norm : mat -> elt *) -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : mat -> mat -> mat diff --git a/src/owl/sparse/owl_sparse_matrix_d.mli b/src/owl/sparse/owl_sparse_matrix_d.mli index 5333d1c6d..e022d5200 100644 --- a/src/owl/sparse/owl_sparse_matrix_d.mli +++ b/src/owl/sparse/owl_sparse_matrix_d.mli @@ -7,7 +7,7 @@ type elt = float type mat = (float, Bigarray.float64_elt) Owl_sparse_matrix_generic.t -(** {6 Create sparse matrices} *) +(** {5 Create sparse matrices} *) val zeros : int -> int -> mat @@ -25,7 +25,7 @@ val sequential : int -> int -> mat val linspace : elt -> elt -> int -> mat -(** {6 Obtain the basic properties of a matrix} *) +(** {5 Obtain the basic properties of a matrix} *) val shape : mat -> int * int @@ -47,7 +47,7 @@ val nnz_cols : mat -> int array val density : mat -> float -(** {6 Manipulate a matrix} *) +(** {5 Manipulate a matrix} *) val insert : mat -> int -> int -> elt -> unit @@ -75,7 +75,7 @@ val cols : mat -> int array -> mat val prune : mat -> elt -> float -> unit -(** {6 Iterate elements, columns, and rows} *) +(** {5 Iterate elements, columns, and rows} *) val iteri : (int -> int -> elt -> unit) -> mat -> unit @@ -149,7 +149,7 @@ val fold_rows_nz : ('a -> mat -> 'a) -> 'a -> mat -> 'a val fold_cols_nz : ('a -> mat -> 'a) -> 'a -> mat -> 'a -(** {6 Examine elements and compare two matrices} *) +(** {5 Examine elements and compare two matrices} *) val exists : (elt -> bool) -> mat -> bool @@ -183,7 +183,7 @@ val greater_equal : mat -> mat -> bool val less_equal : mat -> mat -> bool -(** {6 Randomisation functions} *) +(** {5 Randomisation functions} *) val permutation_matrix : int -> mat @@ -197,7 +197,7 @@ val shuffle_cols : mat -> mat val shuffle : mat -> mat -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : mat -> (int array * elt) array @@ -213,7 +213,7 @@ val save : mat -> string -> unit val load : string -> mat -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val min : mat -> elt @@ -243,7 +243,7 @@ val l1norm : mat -> elt val l2norm : mat -> elt -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : mat -> mat -> mat diff --git a/src/owl/sparse/owl_sparse_matrix_generic.mli b/src/owl/sparse/owl_sparse_matrix_generic.mli index c7b8ead20..db2e73291 100644 --- a/src/owl/sparse/owl_sparse_matrix_generic.mli +++ b/src/owl/sparse/owl_sparse_matrix_generic.mli @@ -5,7 +5,7 @@ (** Sparse matrix module *) -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) t (** @@ -17,7 +17,7 @@ type ('a, 'b) kind = ('a, 'b) Bigarray.kind Type of sparse matrices. It is defined in ``types.ml`` as record type. *) -(** {6 Create sparse matrices} *) +(** {5 Create sparse matrices} *) val zeros : ?density:float -> ('a, 'b) kind -> int -> int -> ('a, 'b) t (** @@ -53,7 +53,7 @@ adjusts the interval to ``(0,a)``. val sequential : ('a, 'b) kind -> int -> int -> ('a, 'b) t (** TODO *) -(** {6 Obtain the basic properties} *) +(** {5 Obtain the basic properties} *) val shape : ('a, 'b) t -> int * int (** @@ -111,7 +111,7 @@ equivalent to ``nnz x`` divided by ``numel x``. val kind : ('a, 'b) t -> ('a, 'b) kind -(** {6 Manipulate a matrix} *) +(** {5 Manipulate a matrix} *) val get : ('a, 'b) t -> int -> int -> 'a (** @@ -188,7 +188,7 @@ val concat_horizontal : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t ``concat_horizontal x y`` not implemented yet *) -(** {6 Iterate elements, columns, and rows} *) +(** {5 Iterate elements, columns, and rows} *) val iteri : (int -> int -> 'a -> unit) -> ('a, 'b) t -> unit (** @@ -393,7 +393,7 @@ val fold_cols_nz : ('c -> ('a, 'b) t -> 'c) -> 'c -> ('a, 'b) t -> 'c columns in ``x`` using function ``f``. Zero columns will be dropped in iterating ``x``. *) -(** {6 Examine elements and compare two matrices} *) +(** {5 Examine elements and compare two matrices} *) val exists : ('a -> bool) -> ('a, 'b) t -> bool (** @@ -488,7 +488,7 @@ val less_equal : ('a, 'b) t -> ('a, 'b) t -> bool greater than the corresponding elements in ``y``. *) -(** {6 Randomisation functions} *) +(** {5 Randomisation functions} *) val permutation_matrix : ('a, 'b) kind -> int -> ('a, 'b) t (** @@ -525,7 +525,7 @@ val shuffle : ('a, 'b) t -> ('a, 'b) t rows then shuffling along columns. It is equivalent to ``shuffle_cols (shuffle_rows x)``. *) -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : ('a, 'b) t -> (int array * 'a) array (** TODO *) @@ -567,7 +567,7 @@ val load : ('a, 'b) kind -> string -> ('a, 'b) t saved by using ``save`` function. *) -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val min : (float, 'a) t -> float (** @@ -640,7 +640,7 @@ val l1norm : (float, 'b) t -> float val l2norm : (float, 'b) t -> float (** TODO *) -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t (** diff --git a/src/owl/sparse/owl_sparse_matrix_s.mli b/src/owl/sparse/owl_sparse_matrix_s.mli index f5273e4c8..160ff7c1e 100644 --- a/src/owl/sparse/owl_sparse_matrix_s.mli +++ b/src/owl/sparse/owl_sparse_matrix_s.mli @@ -7,7 +7,7 @@ type elt = float type mat = (float, Bigarray.float32_elt) Owl_sparse_matrix_generic.t -(** {6 Create sparse matrices} *) +(** {5 Create sparse matrices} *) val zeros : int -> int -> mat @@ -25,7 +25,7 @@ val sequential : int -> int -> mat val linspace : elt -> elt -> int -> mat -(** {6 Obtain the basic properties of a matrix} *) +(** {5 Obtain the basic properties of a matrix} *) val shape : mat -> int * int @@ -47,7 +47,7 @@ val nnz_cols : mat -> int array val density : mat -> float -(** {6 Manipulate a matrix} *) +(** {5 Manipulate a matrix} *) val insert : mat -> int -> int -> elt -> unit @@ -75,7 +75,7 @@ val cols : mat -> int array -> mat val prune : mat -> elt -> float -> unit -(** {6 Iterate elements, columns, and rows} *) +(** {5 Iterate elements, columns, and rows} *) val iteri : (int -> int -> elt -> unit) -> mat -> unit @@ -149,7 +149,7 @@ val fold_rows_nz : ('a -> mat -> 'a) -> 'a -> mat -> 'a val fold_cols_nz : ('a -> mat -> 'a) -> 'a -> mat -> 'a -(** {6 Examine elements and compare two matrices} *) +(** {5 Examine elements and compare two matrices} *) val exists : (elt -> bool) -> mat -> bool @@ -183,7 +183,7 @@ val greater_equal : mat -> mat -> bool val less_equal : mat -> mat -> bool -(** {6 Randomisation functions} *) +(** {5 Randomisation functions} *) val permutation_matrix : int -> mat @@ -197,7 +197,7 @@ val shuffle_cols : mat -> mat val shuffle : mat -> mat -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : mat -> (int array * elt) array @@ -213,7 +213,7 @@ val save : mat -> string -> unit val load : string -> mat -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val min : mat -> elt @@ -243,7 +243,7 @@ val l1norm : mat -> elt val l2norm : mat -> elt -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : mat -> mat -> mat diff --git a/src/owl/sparse/owl_sparse_matrix_z.mli b/src/owl/sparse/owl_sparse_matrix_z.mli index b08fffb97..64e5aefd9 100644 --- a/src/owl/sparse/owl_sparse_matrix_z.mli +++ b/src/owl/sparse/owl_sparse_matrix_z.mli @@ -7,7 +7,7 @@ type elt = Complex.t type mat = (Complex.t, Bigarray.complex64_elt) Owl_sparse_matrix_generic.t -(** {6 Create sparse matrices} *) +(** {5 Create sparse matrices} *) val zeros : int -> int -> mat @@ -23,7 +23,7 @@ val uniform_int : ?a:int -> ?b:int -> int -> int -> mat val sequential : int -> int -> mat -(** {6 Obtain the basic properties of a matrix} *) +(** {5 Obtain the basic properties of a matrix} *) val shape : mat -> int * int @@ -45,7 +45,7 @@ val nnz_cols : mat -> int array val density : mat -> float -(** {6 Manipulate a matrix} *) +(** {5 Manipulate a matrix} *) val insert : mat -> int -> int -> elt -> unit @@ -73,7 +73,7 @@ val cols : mat -> int array -> mat val prune : mat -> elt -> float -> unit -(** {6 Iterate elements, columns, and rows} *) +(** {5 Iterate elements, columns, and rows} *) val iteri : (int -> int -> elt -> unit) -> mat -> unit @@ -147,7 +147,7 @@ val fold_rows_nz : ('a -> mat -> 'a) -> 'a -> mat -> 'a val fold_cols_nz : ('a -> mat -> 'a) -> 'a -> mat -> 'a -(** {6 Examine elements and compare two matrices} *) +(** {5 Examine elements and compare two matrices} *) val exists : (elt -> bool) -> mat -> bool @@ -181,7 +181,7 @@ val greater_equal : mat -> mat -> bool val less_equal : mat -> mat -> bool -(** {6 Randomisation functions} *) +(** {5 Randomisation functions} *) val permutation_matrix : int -> mat @@ -195,7 +195,7 @@ val shuffle_cols : mat -> mat val shuffle : mat -> mat -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : mat -> (int array * elt) array @@ -211,7 +211,7 @@ val save : mat -> string -> unit val load : string -> mat -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val trace : mat -> elt @@ -233,7 +233,7 @@ val neg : mat -> mat (* val l2norm : mat -> elt *) -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : mat -> mat -> mat diff --git a/src/owl/sparse/owl_sparse_ndarray_c.mli b/src/owl/sparse/owl_sparse_ndarray_c.mli index 677189b5a..cee7e067d 100644 --- a/src/owl/sparse/owl_sparse_ndarray_c.mli +++ b/src/owl/sparse/owl_sparse_ndarray_c.mli @@ -7,7 +7,7 @@ type elt = Complex.t type arr = (Complex.t, Bigarray.complex32_elt) Owl_sparse_ndarray_generic.t -(** {6 Create sparse ndarray} *) +(** {5 Create sparse ndarray} *) val zeros : int array -> arr @@ -15,7 +15,7 @@ val binary : ?density:float -> int array -> arr val uniform : ?scale:float -> ?density:float -> int array -> arr -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : arr -> int array @@ -33,7 +33,7 @@ val same_shape : arr -> arr -> bool val kind : arr -> (elt, Bigarray.complex32_elt) Bigarray.kind -(** {6 Manipulate a N-dimensional array} *) +(** {5 Manipulate a N-dimensional array} *) val get : arr -> int array -> elt @@ -51,7 +51,7 @@ val transpose : ?axis:int array -> arr -> arr val swap : int -> int -> arr -> arr -(** {6 Iterate array elements} *) +(** {5 Iterate array elements} *) val iteri : ?axis:int option array -> (int array -> elt -> unit) -> arr -> unit @@ -93,7 +93,7 @@ val foldi_nz : ?axis:int option array -> (int array -> 'c -> elt -> 'c) -> 'c -> val fold_nz : ?axis:int option array -> ('c -> elt -> 'c) -> 'c -> arr -> 'c -(** {6 Examine array elements or compare two arrays } *) +(** {5 Examine array elements or compare two arrays } *) val exists : (elt -> bool) -> arr -> bool @@ -123,7 +123,7 @@ val greater_equal : arr -> arr -> bool val less_equal : arr -> arr -> bool -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : arr -> (int array * elt) array @@ -135,7 +135,7 @@ val save : arr -> string -> unit val load : string -> arr -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val neg : arr -> arr @@ -143,7 +143,7 @@ val sum : arr -> elt val mean : arr -> elt -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : arr -> arr -> arr diff --git a/src/owl/sparse/owl_sparse_ndarray_d.mli b/src/owl/sparse/owl_sparse_ndarray_d.mli index 0a0552351..61aa1bc7d 100644 --- a/src/owl/sparse/owl_sparse_ndarray_d.mli +++ b/src/owl/sparse/owl_sparse_ndarray_d.mli @@ -7,7 +7,7 @@ type elt = float type arr = (float, Bigarray.float64_elt) Owl_sparse_ndarray_generic.t -(** {6 Create sparse ndarray} *) +(** {5 Create sparse ndarray} *) val zeros : int array -> arr @@ -15,7 +15,7 @@ val binary : ?density:float -> int array -> arr val uniform : ?scale:float -> ?density:float -> int array -> arr -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : arr -> int array @@ -33,7 +33,7 @@ val same_shape : arr -> arr -> bool val kind : arr -> (elt, Bigarray.float64_elt) Bigarray.kind -(** {6 Manipulate a N-dimensional array} *) +(** {5 Manipulate a N-dimensional array} *) val get : arr -> int array -> elt @@ -51,7 +51,7 @@ val transpose : ?axis:int array -> arr -> arr val swap : int -> int -> arr -> arr -(** {6 Iterate array elements} *) +(** {5 Iterate array elements} *) val iteri : ?axis:int option array -> (int array -> elt -> unit) -> arr -> unit @@ -93,7 +93,7 @@ val foldi_nz : ?axis:int option array -> (int array -> 'c -> elt -> 'c) -> 'c -> val fold_nz : ?axis:int option array -> ('c -> elt -> 'c) -> 'c -> arr -> 'c -(** {6 Examine array elements or compare two arrays } *) +(** {5 Examine array elements or compare two arrays } *) val exists : (elt -> bool) -> arr -> bool @@ -123,7 +123,7 @@ val greater_equal : arr -> arr -> bool val less_equal : arr -> arr -> bool -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : arr -> (int array * elt) array @@ -135,7 +135,7 @@ val save : arr -> string -> unit val load : string -> arr -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val min : arr -> elt @@ -151,7 +151,7 @@ val sum : arr -> elt val mean : arr -> elt -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : arr -> arr -> arr diff --git a/src/owl/sparse/owl_sparse_ndarray_generic.mli b/src/owl/sparse/owl_sparse_ndarray_generic.mli index 18e79f7cf..1137b9710 100644 --- a/src/owl/sparse/owl_sparse_ndarray_generic.mli +++ b/src/owl/sparse/owl_sparse_ndarray_generic.mli @@ -5,7 +5,7 @@ (** Sparse N-dimensional array module *) -(** {6 Type definition} *) +(** {5 Type definition} *) type ('a, 'b) kind = ('a, 'b) Bigarray.kind (** Type of ``kind``. *) @@ -13,7 +13,7 @@ type ('a, 'b) kind = ('a, 'b) Bigarray.kind type ('a, 'b) t (** Abstract type of sparse ndarray. *) -(** {6 Create sparse ndarray} *) +(** {5 Create sparse ndarray} *) val zeros : ('a, 'b) kind -> int array -> ('a, 'b) t (** TODO *) @@ -24,7 +24,7 @@ val binary : ?density:float -> ('a, 'b) kind -> int array -> ('a, 'b) t val uniform : ?scale:float -> ?density:float -> ('a, 'b) kind -> int array -> ('a, 'b) t (** TODO *) -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : ('a, 'b) t -> int array (** TODO *) @@ -50,7 +50,7 @@ val same_shape : ('a, 'b) t -> ('a, 'b) t -> bool val kind : ('a, 'b) t -> ('a, 'b) kind (** TODO *) -(** {6 Manipulate a N-dimensional array} *) +(** {5 Manipulate a N-dimensional array} *) val get : ('a, 'b) t -> int array -> 'a (** TODO *) @@ -76,7 +76,7 @@ val transpose : ?axis:int array -> ('a, 'b) t -> ('a, 'b) t val swap : int -> int -> ('a, 'b) t -> ('a, 'b) t (** TODO *) -(** {6 Iterate array elements} *) +(** {5 Iterate array elements} *) val iteri : ?axis:int option array -> (int array -> 'a -> unit) -> ('a, 'b) t -> unit (** TODO *) @@ -148,7 +148,7 @@ val foldi_nz val fold_nz : ?axis:int option array -> ('c -> 'a -> 'c) -> 'c -> ('a, 'b) t -> 'c (** TODO *) -(** {6 Examine array elements or compare two arrays } *) +(** {5 Examine array elements or compare two arrays } *) val exists : ('a -> bool) -> ('a, 'b) t -> bool (** TODO *) @@ -192,7 +192,7 @@ val greater_equal : ('a, 'b) t -> ('a, 'b) t -> bool val less_equal : ('a, 'b) t -> ('a, 'b) t -> bool (** TODO *) -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : ('a, 'b) t -> (int array * 'a) array (** TODO *) @@ -212,7 +212,7 @@ val save : ('a, 'b) t -> string -> unit val load : ('a, 'b) kind -> string -> ('a, 'b) t (** TODO *) -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val min : ('a, 'b) t -> 'a (** TODO *) @@ -235,7 +235,7 @@ val sum : ('a, 'b) t -> 'a val mean : ('a, 'b) t -> 'a (** TODO *) -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t (** TODO *) diff --git a/src/owl/sparse/owl_sparse_ndarray_s.mli b/src/owl/sparse/owl_sparse_ndarray_s.mli index 12e8ccc02..63706e4aa 100644 --- a/src/owl/sparse/owl_sparse_ndarray_s.mli +++ b/src/owl/sparse/owl_sparse_ndarray_s.mli @@ -7,7 +7,7 @@ type elt = float type arr = (float, Bigarray.float32_elt) Owl_sparse_ndarray_generic.t -(** {6 Create sparse ndarray} *) +(** {5 Create sparse ndarray} *) val zeros : int array -> arr @@ -15,7 +15,7 @@ val binary : ?density:float -> int array -> arr val uniform : ?scale:float -> ?density:float -> int array -> arr -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : arr -> int array @@ -33,7 +33,7 @@ val same_shape : arr -> arr -> bool val kind : arr -> (elt, Bigarray.float32_elt) Bigarray.kind -(** {6 Manipulate a N-dimensional array} *) +(** {5 Manipulate a N-dimensional array} *) val get : arr -> int array -> elt @@ -51,7 +51,7 @@ val transpose : ?axis:int array -> arr -> arr val swap : int -> int -> arr -> arr -(** {6 Iterate array elements} *) +(** {5 Iterate array elements} *) val iteri : ?axis:int option array -> (int array -> elt -> unit) -> arr -> unit @@ -93,7 +93,7 @@ val foldi_nz : ?axis:int option array -> (int array -> 'c -> elt -> 'c) -> 'c -> val fold_nz : ?axis:int option array -> ('c -> elt -> 'c) -> 'c -> arr -> 'c -(** {6 Examine array elements or compare two arrays } *) +(** {5 Examine array elements or compare two arrays } *) val exists : (elt -> bool) -> arr -> bool @@ -123,7 +123,7 @@ val greater_equal : arr -> arr -> bool val less_equal : arr -> arr -> bool -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : arr -> (int array * elt) array @@ -135,7 +135,7 @@ val save : arr -> string -> unit val load : string -> arr -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val min : arr -> elt @@ -151,7 +151,7 @@ val sum : arr -> elt val mean : arr -> elt -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : arr -> arr -> arr diff --git a/src/owl/sparse/owl_sparse_ndarray_z.mli b/src/owl/sparse/owl_sparse_ndarray_z.mli index f9792012c..d9af44afb 100644 --- a/src/owl/sparse/owl_sparse_ndarray_z.mli +++ b/src/owl/sparse/owl_sparse_ndarray_z.mli @@ -7,7 +7,7 @@ type elt = Complex.t type arr = (Complex.t, Bigarray.complex64_elt) Owl_sparse_ndarray_generic.t -(** {6 Create sparse ndarray} *) +(** {5 Create sparse ndarray} *) val zeros : int array -> arr @@ -15,7 +15,7 @@ val binary : ?density:float -> int array -> arr val uniform : ?scale:float -> ?density:float -> int array -> arr -(** {6 Obtain basic properties} *) +(** {5 Obtain basic properties} *) val shape : arr -> int array @@ -33,7 +33,7 @@ val same_shape : arr -> arr -> bool val kind : arr -> (elt, Bigarray.complex64_elt) Bigarray.kind -(** {6 Manipulate a N-dimensional array} *) +(** {5 Manipulate a N-dimensional array} *) val get : arr -> int array -> elt @@ -51,7 +51,7 @@ val transpose : ?axis:int array -> arr -> arr val swap : int -> int -> arr -> arr -(** {6 Iterate array elements} *) +(** {5 Iterate array elements} *) val iteri : ?axis:int option array -> (int array -> elt -> unit) -> arr -> unit @@ -93,7 +93,7 @@ val foldi_nz : ?axis:int option array -> (int array -> 'c -> elt -> 'c) -> 'c -> val fold_nz : ?axis:int option array -> ('c -> elt -> 'c) -> 'c -> arr -> 'c -(** {6 Examine array elements or compare two arrays } *) +(** {5 Examine array elements or compare two arrays } *) val exists : (elt -> bool) -> arr -> bool @@ -123,7 +123,7 @@ val greater_equal : arr -> arr -> bool val less_equal : arr -> arr -> bool -(** {6 Input/Output and helper functions} *) +(** {5 Input/Output and helper functions} *) val to_array : arr -> (int array * elt) array @@ -135,7 +135,7 @@ val save : arr -> string -> unit val load : string -> arr -(** {6 Unary mathematical operations } *) +(** {5 Unary mathematical operations } *) val neg : arr -> arr @@ -143,7 +143,7 @@ val sum : arr -> elt val mean : arr -> elt -(** {6 Binary mathematical operations } *) +(** {5 Binary mathematical operations } *) val add : arr -> arr -> arr diff --git a/src/owl/stats/owl_stats.mli b/src/owl/stats/owl_stats.mli index 347bd1a03..83de9a86f 100644 --- a/src/owl/stats/owl_stats.mli +++ b/src/owl/stats/owl_stats.mli @@ -9,7 +9,7 @@ tests. The module also includes some basic statistical functions such as mean, variance, skew, and etc. *) -(** {6 Randomisation functions} *) +(** {5 Randomisation functions} *) val shuffle : 'a array -> 'a array (** ``shuffle x`` return a new array of the shuffled ``x``. *) @@ -20,7 +20,7 @@ val choose : 'a array -> int -> 'a array val sample : 'a array -> int -> 'a array (** ``sample x n`` draw ``n`` samples from ``x`` with replacement. *) -(** {6 Basic statistical functions} *) +(** {5 Basic statistical functions} *) val sum : float array -> float (** ``sum x`` returns the summation of the elements in ``x``. *) @@ -264,7 +264,7 @@ Bandwidth selection rules is as follows: The default bandwidth value is ``Scott``. *) -(** {6 MCMC: Markov Chain Monte Carlo} *) +(** {5 MCMC: Markov Chain Monte Carlo} *) val metropolis_hastings : (float array -> float) @@ -286,7 +286,7 @@ TODO: ``gibbs_sampling f p n`` is Gibbs sampler. f is a sampler based on the ful conditional function of all variables *) -(** {6 Hypothesis tests} *) +(** {5 Hypothesis tests} *) type hypothesis = { reject : bool @@ -433,7 +433,7 @@ Statistica Sinica 7 805-813), else usning asymptotic normal distribution. val wilcoxon : ?alpha:float -> ?side:tail -> float array -> float array -> hypothesis (** TODO *) -(** {6 Discrete random variables} *) +(** {5 Discrete random variables} *) (** The ``_rvs`` functions generate random numbers according to @@ -553,7 +553,7 @@ categorical distribution. This is equavalent to only one trial from ``multinomial_rvs`` function, so it is just a simple wrapping. *) -(** {6 Continuous random variables} *) +(** {5 Continuous random variables} *) val std_uniform_rvs : unit -> float (** TODO *) diff --git a/src/plplot/owl_plot.mli b/src/plplot/owl_plot.mli index 269b3e26e..0b7505e60 100644 --- a/src/plplot/owl_plot.mli +++ b/src/plplot/owl_plot.mli @@ -8,7 +8,7 @@ (** The input to a plot function is supposed to be a row-based matrix/vector. * The functions in this module are built atop of Plplot library. *) -(** {6 Type definition} *) +(** {5 Type definition} *) type dsmat = Owl_dense_matrix.D.mat (** Default input type is double precision matrices. *) @@ -57,7 +57,7 @@ type spec = | Faceted | Axis of axis (** specification of a figure *) -(** {6 Config functions} *) +(** {5 Config functions} *) val create : ?m:int -> ?n:int -> string -> handle (** @@ -169,7 +169,7 @@ val legend_off : handle -> unit ``legend_off`` *) -(** {6 Basic plot functions} *) +(** {5 Basic plot functions} *) (** Line style is an integer ranging from 1 to 8. *) @@ -323,7 +323,7 @@ non-zero elements are plotted as dots, and zeros are ignored. Parameters: ``RGB``, ``Marker``, ``MarkerSize``. *) -(** {6 Plot 3D figures} *) +(** {5 Plot 3D figures} *) val plot3d : ?h:handle -> ?spec:spec list -> dsmat -> dsmat -> dsmat -> unit (** Note ``plot3d`` is just an alias of ``surf`` function. @@ -356,7 +356,7 @@ val heatmap : ?h:handle -> dsmat -> dsmat -> dsmat -> unit (** ``heatmap x y z`` generates a heatmap defined by ``x``, ``y``, and ``z``. *) -(** {6 Advanced statistical plot} *) +(** {5 Advanced statistical plot} *) val probplot : ?h:handle diff --git a/src/top/owl_top.mli b/src/top/owl_top.mli index d0b1dd389..59b91a362 100644 --- a/src/top/owl_top.mli +++ b/src/top/owl_top.mli @@ -3,7 +3,7 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Core functions} *) +(** {5 Core functions} *) val printers : string list (** List of registered pretty printers for Owl. *) diff --git a/src/zoo/owl_zoo_cmd.mli b/src/zoo/owl_zoo_cmd.mli index 0d9d7009c..68f713120 100644 --- a/src/zoo/owl_zoo_cmd.mli +++ b/src/zoo/owl_zoo_cmd.mli @@ -3,7 +3,7 @@ * Copyright (c) 2016-2020 Liang Wang *) -(** {6 Manipulate gists} *) +(** {5 Manipulate gists} *) val remove_gist : string -> unit (** Remove a local gist of given id. *) @@ -23,7 +23,7 @@ val update_gist : string array -> unit val show_info : string -> unit (** Show the gist's detail information of given gist id. *) -(** {6 Execute gists} *) +(** {5 Execute gists} *) val eval : string -> unit (** Evaluate an OCaml expression in toplevel. *) @@ -37,7 +37,7 @@ val run : string array -> string -> unit val run_gist : string -> string array -> unit (** ``run_gist gist-id`` runs a zoo gist with the given ``gist-id`` and parameters. *) -(** {6 Helper functions} *) +(** {5 Helper functions} *) val print_info : unit -> unit (** Print out help information of ``owl`` command line. *)