From 8e474b0839a1655a114a0dfb5f62fb765cc0817a Mon Sep 17 00:00:00 2001 From: "J.Stark" Date: Wed, 6 Mar 2024 19:18:04 +0100 Subject: [PATCH] update workflow --- .github/workflows/main.yml | 8 ++++++-- README.md | 3 +-- src/owl/fftpack/owl_fft_generic.mli | 6 +++--- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 6d091028f..2fb24f4d8 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -6,9 +6,10 @@ on: - main jobs: - deploy: - name: Deploy Owl doc + deploy-owl: + name: Install Owl and build doc runs-on: ubuntu-latest + steps: - uses: actions/checkout@main @@ -25,6 +26,9 @@ jobs: - name: OCaml Deps run: opam install ocaml-compiler-libs alcotest conf-openblas ctypes dune-configurator stdio npy odoc + - name: Compile Owl and install + run: opam exec -- dune build @install + - name: Build doc run: | opam exec -- dune build @doc diff --git a/README.md b/README.md index e0bdd6a9f..a7eb9e5c1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -# Owl - OCaml Scientific Computing [![Build Status](https://travis-ci.org/owlbarn/owl.svg?branch=master)](https://travis-ci.org/owlbarn/owl) -[![build](https://github.com/owlbarn/owl/actions/workflows/main.yml/badge.svg)](https://github.com/owlbarn/owl/actions/workflows/main.yml) +# Owl - OCaml Scientific Computing [![build](https://github.com/owlbarn/owl/actions/workflows/main.yml/badge.svg)](https://github.com/owlbarn/owl/actions/workflows/main.yml) Owl is a dedicated system for scientific and engineering computing. The system is developed in OCaml and licensed under MIT. The project is originated by [Liang Wang](https://liang.ocaml.xyz) and currently led by [Jianxin Zhao](https://jianxin.ocaml.xyz). The history of the project is on the [Wikipedia](https://en.wikipedia.org/wiki/Owl_Scientific_Computing). diff --git a/src/owl/fftpack/owl_fft_generic.mli b/src/owl/fftpack/owl_fft_generic.mli index 01c27feb6..d805a3b4c 100644 --- a/src/owl/fftpack/owl_fft_generic.mli +++ b/src/owl/fftpack/owl_fft_generic.mli @@ -17,8 +17,8 @@ highest dimension if not specified. The return is not scaled. val ifft : ?axis:int -> (Complex.t, 'a) t -> (Complex.t, 'a) t (** -[ifft ~axis x] performs inverse 1-dimensional FFT on a complex input. [axis] -is the highest dimension by default. +[ifft ~axis x] performs inverse 1-dimensional FFT on a complex input. The parameter [axis] +indicates the highest dimension by default. *) val rfft : ?axis:int -> otyp:(Complex.t, 'a) kind -> (float, 'b) t -> (Complex.t, 'a) t @@ -29,7 +29,7 @@ precision with input [x]. You can skip this parameter by using a submodule with specific precision such as [Owl.Fft.S] or [Owl.Fft.D]. *) -val irfft + val irfft : ?axis:int -> ?n:int -> otyp:(float, 'a) kind