Skip to content

Commit 80c412d

Browse files
tomhennigancopybara-github
authored andcommitted
Update github links to dm-haiku, link out to haiku-os.org from readme.
Closes #2. PiperOrigin-RevId: 296413851 Change-Id: If01c3f5356c43999da58bce0b053a5a142303aff
1 parent a263b87 commit 80c412d

File tree

6 files changed

+24
-21
lines changed

6 files changed

+24
-21
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ getting started, Github has a
3232

3333
If you want to contribute but you're not sure where to start, take a look at the
3434
[issues with the "contributions welcome"
35-
label](https://github.com/deepmind/haiku/labels/stat%3Acontributions%20welcome).
35+
label](https://github.com/deepmind/dm-haiku/labels/stat%3Acontributions%20welcome).
3636
These are issues that we believe are particularly well suited for outside
3737
contributions, often because we probably won't get to them right now. If you
3838
decide to start on an issue, leave a comment so that other people know that

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
| [**Why Haiku?**](#why-haiku)
55
| [**Quickstart**](#quickstart)
66
| [**Installation**](#installation)
7-
| [**Examples**](https://github.com/deepmind/haiku/tree/master/examples/)
7+
| [**Examples**](https://github.com/deepmind/dm-haiku/tree/master/examples/)
88
| [**User manual**](#user-manual)
99
| [**Documentation**](https://dm-haiku.readthedocs.io/)
1010
| [**Citing Haiku**](#citing-haiku)
@@ -16,10 +16,13 @@ Haiku is a simple neural network library for
1616
authors of [Sonnet](https://github.com/deepmind/sonnet), a neural network
1717
library for [TensorFlow](https://github.com/tensorflow/tensorflow).
1818

19+
**Disambiguation:** if you are looking for Haiku the operating system then
20+
please see https://haiku-os.org/.
21+
1922
NOTE: Haiku is currently **alpha**. A number of researchers have tested Haiku
2023
for several months and have reproduced a number of experiments at scale. Please
2124
feel free to use Haiku, but be sure to test any assumptions and to
22-
[let us know](https://github.com/deepmind/haiku/issues) if things don't look
25+
[let us know](https://github.com/deepmind/dm-haiku/issues) if things don't look
2326
right!
2427

2528
## Overview
@@ -180,9 +183,9 @@ entries in `params` and `grads`. The result has the same structure as the previo
180183
`params` and can again be used with `apply`.
181184

182185
For more, see our
183-
[examples directory](https://github.com/deepmind/haiku/tree/master/examples/).
186+
[examples directory](https://github.com/deepmind/dm-haiku/tree/master/examples/).
184187
The
185-
[MNIST example](https://github.com/deepmind/haiku/tree/master/examples/mnist.py)
188+
[MNIST example](https://github.com/deepmind/dm-haiku/tree/master/examples/mnist.py)
186189
is a good place to start.
187190

188191
## Installation
@@ -198,7 +201,7 @@ to install JAX with the relevant accelerator support.
198201
Then, install Haiku using pip:
199202

200203
```bash
201-
$ pip install git+https://github.com/deepmind/haiku
204+
$ pip install git+https://github.com/deepmind/dm-haiku
202205
```
203206

204207
## User manual
@@ -348,7 +351,7 @@ for _ in range(10):
348351
```
349352

350353
For a more complete look at distributed Haiku training, take a look at our
351-
[ResNet-50 on ImageNet example](https://github.com/deepmind/haiku/tree/master/examples/imagenet/).
354+
[ResNet-50 on ImageNet example](https://github.com/deepmind/dm-haiku/tree/master/examples/imagenet/).
352355

353356
## Citing Haiku
354357

@@ -358,12 +361,12 @@ To cite this repository:
358361
@software{haiku2020github,
359362
author = {Tom Hennigan and Trevor Cai and Tamara Norman and Igor Babuschkin},
360363
title = {{H}aiku: {S}onnet for {JAX}},
361-
url = {https://github.com/deepmind/haiku},
364+
url = {https://github.com/deepmind/dm-haiku},
362365
version = {0.0.1a0},
363366
year = {2020},
364367
}
365368
```
366369

367370
In this bibtex entry, the version number is intended to be from
368-
[haiku/__init__.py](https://github.com/deepmind/haiku/blob/master/haiku/__init__.py),
371+
[`haiku/__init__.py`](https://github.com/deepmind/dm-haiku/blob/master/haiku/__init__.py),
369372
and the year corresponds to the project's open-source release.

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,6 @@ def linkcode_resolve(domain, info):
152152
return None
153153

154154
# TODO(slebedev): support tags after we release an initial version.
155-
return 'https://github.com/deepmind/haiku/blob/master/haiku/%s#L%d#L%d' % (
155+
return 'https://github.com/deepmind/dm-haiku/blob/master/haiku/%s#L%d#L%d' % (
156156
os.path.relpath(filename, start=os.path.dirname(
157157
hk.__file__)), lineno, lineno + len(source) - 1)

docs/index.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:github_url: https://github.com/deepmind/haiku/tree/master/docs
1+
:github_url: https://github.com/deepmind/dm-haiku/tree/master/docs
22

33
Haiku Documentation
44
===================
@@ -31,7 +31,7 @@ installing JAX.
3131

3232
Install Haiku by running::
3333

34-
$ pip install git+https://github.com/deepmind/haiku
34+
$ pip install git+https://github.com/deepmind/dm-haiku
3535

3636
.. toctree::
3737
:caption: Guides
@@ -48,14 +48,14 @@ Install Haiku by running::
4848
Contribute
4949
----------
5050

51-
- Issue tracker: https://github.com/deepmind/haiku/issues
52-
- Source code: https://github.com/deepmind/haiku/tree/master
51+
- Issue tracker: https://github.com/deepmind/dm-haiku/issues
52+
- Source code: https://github.com/deepmind/dm-haiku/tree/master
5353

5454
Support
5555
-------
5656

5757
If you are having issues, please let us know by filing an issue on our
58-
`issue tracker <https://github.com/deepmind/haiku/issues>`_.
58+
`issue tracker <https://github.com/deepmind/dm-haiku/issues>`_.
5959

6060
License
6161
-------

examples/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## Supervised learning
44

5-
* [MLP on MNIST](https://github.com/deepmind/haiku/blob/master/examples/mnist.py).
6-
* [ResNet50 on ImageNet](https://github.com/deepmind/haiku/tree/master/examples/imagenet/).
7-
* [Transformer on LM1B](https://github.com/deepmind/haiku/blob/master/examples/transformer/train.py)
5+
* [MLP on MNIST](https://github.com/deepmind/dm-haiku/blob/master/examples/mnist.py).
6+
* [ResNet50 on ImageNet](https://github.com/deepmind/dm-haiku/tree/master/examples/imagenet/).
7+
* [Transformer on LM1B](https://github.com/deepmind/dm-haiku/blob/master/examples/transformer/train.py)
88

99
# Reinforcement learning
1010

11-
* [Impala lite](https://github.com/deepmind/haiku/blob/master/examples/impala_lite.py).
12-
* [Impala on Catch](https://github.com/deepmind/haiku/blob/master/examples/impala/run_catch.py).
11+
* [Impala lite](https://github.com/deepmind/dm-haiku/blob/master/examples/impala_lite.py).
12+
* [Impala on Catch](https://github.com/deepmind/dm-haiku/blob/master/examples/impala/run_catch.py).

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def _parse_requirements(requirements_txt_path):
4444
setup(
4545
name='dm-haiku',
4646
version=_VERSION,
47-
url='https://github.com/deepmind/haiku',
47+
url='https://github.com/deepmind/dm-haiku',
4848
license='Apache 2.0',
4949
author='DeepMind',
5050
description='Haiku is a library for building neural networks in JAX.',

0 commit comments

Comments
 (0)