Tweaks to satisfy opam release process

ahrefs · Apr 24, 2024 · d097497 · d097497
1 parent ee638a9
commit d097497
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 10 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,4 +1,4 @@
-## [0.3.3] -- 2024-04-23
+## [0.3.3] -- 2024-04-24
 
 ### Added
 
@@ -9,6 +9,7 @@
 
 - A bit of code rot in the Cuda backend mock `cuda_backend.missing.ml`.
 - NPY: Compatibility with OCaml 5.2.0.
+- Renamed the main package name from `ocannl` to `neural_nets_lib`, to prevent the opam linter from complaining about a confusing name.
 
 ## [0.3.2] -- 2024-04-22
 

diff --git a/README.md b/README.md
@@ -36,14 +36,15 @@ OCANNL is sponsored by [Ahrefs](https://ocaml.org/success-stories/peta-byte-scal
 
 On the critical path for the next major release v0.4:
 
-* Mixed-precision computations: working and convenient.
 * Restore signs of life for the Cuda backend.
+* Mixed-precision computations: working and convenient.
 
 ### Releases
 
 For more details, see [CHANGES](CHANGES.md).
 
 * **v0.3 shape inference, jitted routines**: a major rewrite of the whole project.
+  * **v0.3.3**: continuous integration and opam release.
   * **v0.3.2**: new shape inference feature: tracking leftmost axes -- complete inference for splicing, ellipsis-in-the-middle allowed in einsum notation.
   * **v0.3.1**: sanitizing code inclusion (rootness checks).
   * **v0.3.0**: declarative shape inference; replaced the session interface with a "jitted code routines" API. Cuda defunct.
@@ -76,6 +77,8 @@ OCANNL follows different design choices than [OWL](https://ocaml.xyz/). For exam
 
 ## Installation
 
+Although the project is called `ocannl`, the main package is called `neural_nets_lib`, to avoid the (opam linter's) complaint that the name can be confused with other packages. This also clarifies that `ocannl` is composed of `arrayjit` and `neural_nets_lib`.
+
 The dependency on `ocaml-cudajit` is optional, so you have to install it first to enable the Cuda backend.
 
 ## Usage

diff --git a/bin/dune b/bin/dune
@@ -8,7 +8,7 @@
 
 (executable
  ; A placeholder main entry.
- (package ocannl)
+ (package neural_nets_lib)
  (public_name ocannl)
  (name moons_benchmark)
  (modules moons_benchmark)

diff --git a/dune-project b/dune-project
@@ -32,10 +32,12 @@
  (authors "Laurent Mazare")
  (maintainers "Lukasz Stafiniak <[email protected]>")
  (depends
+  ; The real dependency is >= 4.06, but because of multi-package project
+  ; need to keep it in sync with the other packages.
   (ocaml
-   (>= 4.06))
+   (>= 5.1.0))
   camlzip
-  (dune :build)
+  dune
   (conf-python-3 :with-test)))
 
 (package
@@ -69,7 +71,7 @@
   (deeplearning array jit gccjit CUDA)))
 
 (package
- (name ocannl)
+ (name neural_nets_lib)
  (synopsis
   "A from-scratch Deep Learning framework with an optimizing compiler, shape inference, concise syntax")
  (description

diff --git a/lib/dune b/lib/dune
@@ -1,6 +1,6 @@
 (library
  (name ocannl)
- (public_name ocannl)
+ (public_name neural_nets_lib)
  (libraries
   base
   core
@@ -22,7 +22,7 @@
 
 (library
  (name ppx_ocannl)
- (public_name ocannl.ppx_ocannl)
+ (public_name neural_nets_lib.ppx_ocannl)
  (kind ppx_rewriter)
  (modules ppx_shared ppx_cd ppx_op ppx_ocannl)
  (libraries base ppxlib str ppx_arrayjit)

diff --git a/ocannl.opam → neural_nets_lib.opam b/ocannl.opam → neural_nets_lib.opam
diff --git a/ocannl_npy.opam b/ocannl_npy.opam
@@ -9,9 +9,9 @@ homepage: "https://github.com/lukstafi/ocannl"
 doc: "https://github.com/lukstafi/ocannl/blob/master/README.md"
 bug-reports: "https://github.com/lukstafi/ocannl/issues"
 depends: [
-  "ocaml" {>= "4.06"}
+  "ocaml" {>= "5.1.0"}
   "camlzip"
-  "dune" {>= "3.11" & build}
+  "dune" {>= "3.11"}
   "conf-python-3" {with-test}
   "odoc" {with-doc}
 ]