Skip to content

Commit 22ce1d5

Browse files
authored
Update links github links post rename (#1851)
They all work either way, because github handle redirects, but nice to update.
1 parent 9fcafa7 commit 22ce1d5

File tree

8 files changed

+39
-39
lines changed

8 files changed

+39
-39
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ We follow
2020
The fastest way to contribute it to find open issues that need an assignee. We
2121
maintain two lists of github tags for contributors:
2222

23-
- [good first issue](https://github.com/keras-team/keras-nlp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22):
23+
- [good first issue](https://github.com/keras-team/keras-hub/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22):
2424
a list of small, well defined issues for newcomers to the project.
25-
- [contributions welcome](https://github.com/keras-team/keras-nlp/issues?q=is%3Aissue+is%3Aopen+label%3A%22contributions+welcome%22):
25+
- [contributions welcome](https://github.com/keras-team/keras-hub/issues?q=is%3Aissue+is%3Aopen+label%3A%22contributions+welcome%22):
2626
a larger list of issues that may range in complexity.
2727

2828
If you would like propose a new symbol or feature, please first review our
@@ -59,7 +59,7 @@ development environment and run the unit tests. This is covered in section
5959

6060
Once the change is ready, open a pull request from your branch in your fork to
6161
the master branch in
62-
[keras-team/keras-nlp](https://github.com/keras-team/keras-nlp).
62+
[keras-team/keras-hub](https://github.com/keras-team/keras-hub).
6363

6464
### Step 4. Sign the Contributor License Agreement
6565

@@ -88,7 +88,7 @@ KerasHub repository and clone it locally. With the
8888
[GitHub CLI](https://github.com/cli/cli) installed, you can do this as follows:
8989

9090
```shell
91-
gh repo fork keras-team/keras-nlp --clone --remote
91+
gh repo fork keras-team/keras-hub --clone --remote
9292
cd keras-hub
9393
```
9494

CONTRIBUTING_MODELS.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ contribute a new pre-trained model to KerasHub. For illustration purposes, let's
99
assume that you want to contribute the DistilBERT model. Before we dive in, we encourage you to go through
1010
[our getting started guide](https://keras.io/guides/keras_nlp/getting_started/)
1111
for an introduction to the library, and our
12-
[contribution guide](https://github.com/keras-team/keras-nlp/blob/master/CONTRIBUTING.md).
12+
[contribution guide](https://github.com/keras-team/keras-hub/blob/master/CONTRIBUTING.md).
1313

1414
## Checklist
1515

@@ -22,29 +22,29 @@ Keep this checklist handy!
2222

2323
### Step 2: PR #1 - Add XXBackbone
2424

25-
- [ ] An `xx/xx_backbone.py` file which has the model graph \[[Example](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_backbone.py)\].
26-
- [ ] An `xx/xx_backbone_test.py` file which has unit tests for the backbone \[[Example](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_backbone_test.py)\].
25+
- [ ] An `xx/xx_backbone.py` file which has the model graph \[[Example](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_backbone.py)\].
26+
- [ ] An `xx/xx_backbone_test.py` file which has unit tests for the backbone \[[Example](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_backbone_test.py)\].
2727
- [ ] A Colab notebook link in the PR description which matches the outputs of the implemented backbone model with the original source \[[Example](https://colab.research.google.com/drive/1SeZWJorKWmwWJax8ORSdxKrxE25BfhHa?usp=sharing)\].
2828

2929
### Step 3: PR #2 - Add XXTokenizer
3030

31-
- [ ] An `xx/xx_tokenizer.py` file which has the tokenizer for the model \[[Example](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_tokenizer.py)\].
32-
- [ ] An `xx/xx_tokenizer_test.py` file which has unit tests for the model tokenizer \[[Example](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_tokenizer_test.py)\].
31+
- [ ] An `xx/xx_tokenizer.py` file which has the tokenizer for the model \[[Example](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_tokenizer.py)\].
32+
- [ ] An `xx/xx_tokenizer_test.py` file which has unit tests for the model tokenizer \[[Example](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_tokenizer_test.py)\].
3333
- [ ] A Colab notebook link in the PR description, demonstrating that the output of the tokenizer matches the original tokenizer \[[Example](https://colab.research.google.com/drive/1MH_rpuFB1Nz_NkKIAvVtVae2HFLjXZDA?usp=sharing)].
3434

3535
### Step 4: PR #3 - Add XX Presets
3636

37-
- [ ] An `xx/xx_presets.py` file with links to weights uploaded to a personal GCP bucket/Google Drive \[[Example](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_presets.py)\].
38-
- [ ] A `tools/checkpoint_conversion/convert_xx_checkpoints.py` which is reusable script for converting checkpoints \[[Example](https://github.com/keras-team/keras-nlp/blob/master/tools/checkpoint_conversion/convert_distilbert_checkpoints.py)\].
37+
- [ ] An `xx/xx_presets.py` file with links to weights uploaded to a personal GCP bucket/Google Drive \[[Example](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_presets.py)\].
38+
- [ ] A `tools/checkpoint_conversion/convert_xx_checkpoints.py` which is reusable script for converting checkpoints \[[Example](https://github.com/keras-team/keras-hub/blob/master/tools/checkpoint_conversion/convert_distilbert_checkpoints.py)\].
3939
- [ ] A Colab notebook link in the PR description, showing an end-to-end task such as text classification, etc. The task model can be built using the backbone model, with the task head on top \[[Example](https://gist.github.com/mattdangerw/bf0ca07fb66b6738150c8b56ee5bab4e)\].
4040

4141
### Step 5: PR #4 and Beyond - Add XX Tasks and Preprocessors
4242

4343
This PR is optional.
4444

45-
- [ ] An `xx/xx_<task>.py` file for adding a task model like classifier, masked LM, etc. \[[Example](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_classifier.py)\]
46-
- [ ] An `xx/xx_<task>_preprocessor.py` file which has the preprocessor and can be used to get inputs suitable for the task model \[[Example](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_preprocessor.py)\].
47-
- [ ] `xx/xx_<task>_test.py` file and `xx/xx_<task>_preprocessor_test.py` files which have unit tests for the above two modules \[[Example 1](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_classifier_test.py) and [Example 2](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_preprocessor_test.py)\].
45+
- [ ] An `xx/xx_<task>.py` file for adding a task model like classifier, masked LM, etc. \[[Example](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_classifier.py)\]
46+
- [ ] An `xx/xx_<task>_preprocessor.py` file which has the preprocessor and can be used to get inputs suitable for the task model \[[Example](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_preprocessor.py)\].
47+
- [ ] `xx/xx_<task>_test.py` file and `xx/xx_<task>_preprocessor_test.py` files which have unit tests for the above two modules \[[Example 1](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_classifier_test.py) and [Example 2](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_preprocessor_test.py)\].
4848
- [ ] A Colab notebook link in the PR description, demonstrating that the output of the preprocessor matches the output of the original preprocessor \[[Example](https://colab.research.google.com/drive/1GFFC7Y1I_2PtYlWDToqKvzYhHWv1b3nC?usp=sharing)].
4949

5050
## Detailed Instructions
@@ -54,7 +54,7 @@ This section discusses, in details, every necessary step.
5454
### Step 1: Open an issue/Find an open issue
5555

5656
Before getting started with the code, it's important to check if there are any
57-
[open issues](https://github.com/keras-team/keras-nlp/issues?q=is%3Aissue+is%3Aopen+label%3Amodel-contribution)
57+
[open issues](https://github.com/keras-team/keras-hub/issues?q=is%3Aissue+is%3Aopen+label%3Amodel-contribution)
5858
related to the model you wish to contribute. If there is an open issue, you can
5959
claim it by commenting on the issue and letting us know that you're interested
6060
in working on it. This helps us keep track of who is working on what and avoid
@@ -81,7 +81,7 @@ around by a class to implement our models.
8181

8282
A model is typically split into three/four sections. We would recommend you to
8383
compare this side-by-side with the
84-
[`keras_hub.layers.DistilBertBackbone` source code](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_backbone.py)!
84+
[`keras_hub.layers.DistilBertBackbone` source code](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_backbone.py)!
8585

8686
**Inputs to the model**
8787

@@ -117,13 +117,13 @@ This is when things might slightly get complicated.
117117
If the model introduces a paradigm shift, such as using relative attention instead
118118
of vanilla attention, the contributor will have to implement complete custom layers. A case
119119
in point is `keras_hub.models.DebertaV3Backbone` where we had to [implement layers
120-
from scratch](https://github.com/keras-team/keras-nlp/tree/master/keras_hub/models/deberta_v3).
120+
from scratch](https://github.com/keras-team/keras-hub/tree/master/keras_hub/models/deberta_v3).
121121

122122
On the other hand, if the model has a small tweak, something simpler can be done.
123123
For instance, in the Whisper model, the self-attention and cross-attention mechanism
124124
is exactly the same as vanilla attention, with the exception that the key projection
125125
layer does not have a bias term. In this case, we can inherit the custom layer
126-
from one of the standard layers and make minor modifications. See [this PR](https://github.com/keras-team/keras-nlp/pull/801/files#diff-8533ae3a7755c0dbe95ccbb71f85c677297f687bf3884fadefc64f1d0fdce51aR22) for
126+
from one of the standard layers and make minor modifications. See [this PR](https://github.com/keras-team/keras-hub/pull/801/files#diff-8533ae3a7755c0dbe95ccbb71f85c677297f687bf3884fadefc64f1d0fdce51aR22) for
127127
more details.
128128

129129
Since the first PR is only to add the model backbone class, you should omit the
@@ -165,7 +165,7 @@ All the underlying actual tokenization will be taken care of by the superclass.
165165
The important thing here is adding "special tokens". Most models have
166166
special tokens such as beginning-of-sequence token, end-of-sequence token,
167167
mask token, pad token, etc. These have to be
168-
[added as member attributes](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_tokenizer.py#L91-L105)
168+
[added as member attributes](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_tokenizer.py#L91-L105)
169169
to the tokenizer class. These member attributes are then accessed by the
170170
preprocessor layers.
171171

@@ -193,7 +193,7 @@ files. These files will then be uploaded to GCP by us!
193193
After wrapping up the preset configuration file, you need to
194194
add the `from_preset` function to all three classes, i.e., `DistilBertBackbone`,
195195
and `DistilBertTokenizer`. Here is an
196-
[example](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_backbone.py#L187-L189).
196+
[example](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_backbone.py#L187-L189).
197197

198198
The testing for presets is divided into two: "large" and "extra large".
199199
For "large" tests, we pick the smallest preset (in terms of number of parameters)
@@ -228,9 +228,9 @@ and return the dictionary in the form expected by the model.
228228

229229
The preprocessor class might have a few intricacies depending on the model. For example,
230230
the DeBERTaV3 tokenizer does not have the `[MASK]` in the provided sentencepiece
231-
proto file, and we had to make some modifications [here](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/models/deberta_v3/deberta_v3_preprocessor.py). Secondly, we have
231+
proto file, and we had to make some modifications [here](https://github.com/keras-team/keras-hub/blob/master/keras_hub/models/deberta_v3/deberta_v3_preprocessor.py). Secondly, we have
232232
a separate preprocessor class for every task. This is because different tasks
233-
might require different input formats. For instance, we have a [separate preprocessor](https://github.com/keras-team/keras-nlp/blob/master/keras_hub/src/models/distil_bert/distil_bert_masked_lm_preprocessor.py)
233+
might require different input formats. For instance, we have a [separate preprocessor](https://github.com/keras-team/keras-hub/blob/master/keras_hub/src/models/distil_bert/distil_bert_masked_lm_preprocessor.py)
234234
for masked language modeling (MLM) for DistilBERT.
235235

236236
## Conclusion

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# KerasNLP: Multi-framework NLP Models
2-
[![](https://github.com/keras-team/keras-nlp/workflows/Tests/badge.svg?branch=master)](https://github.com/keras-team/keras-nlp/actions?query=workflow%3ATests+branch%3Amaster)
2+
[![](https://github.com/keras-team/keras-hub/workflows/Tests/badge.svg?branch=master)](https://github.com/keras-team/keras-hub/actions?query=workflow%3ATests+branch%3Amaster)
33
![Python](https://img.shields.io/badge/python-v3.9.0+-success.svg)
4-
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/keras-team/keras-nlp/issues)
4+
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/keras-team/keras-hub/issues)
55

66
> [!IMPORTANT]
77
> 📢 KerasNLP is becoming KerasHub! 📢 Read
8-
> [the announcement](https://github.com/keras-team/keras-nlp/issues/1831).
8+
> [the announcement](https://github.com/keras-team/keras-hub/issues/1831).
99
>
1010
> We have renamed the repo to KerasHub in preparation for the release, but have not yet
1111
> released the new package. Follow the announcement for news.
@@ -45,7 +45,7 @@ We welcome contributions.
4545
- [Roadmap](ROADMAP.md)
4646
- [Style Guide](STYLE_GUIDE.md)
4747
- [API Design Guide](API_DESIGN_GUIDE.md)
48-
- [Call for Contributions](https://github.com/keras-team/keras-nlp/issues?q=is%3Aissue+is%3Aopen+label%3A%22contributions+welcome%22)
48+
- [Call for Contributions](https://github.com/keras-team/keras-hub/issues?q=is%3Aissue+is%3Aopen+label%3A%22contributions+welcome%22)
4949

5050
## Quickstart
5151

@@ -156,14 +156,14 @@ Here is the BibTeX entry:
156156
author={Watson, Matthew, and Qian, Chen, and Bischof, Jonathan and Chollet,
157157
Fran\c{c}ois and others},
158158
year={2022},
159-
howpublished={\url{https://github.com/keras-team/keras-nlp}},
159+
howpublished={\url{https://github.com/keras-team/keras-hub}},
160160
}
161161
```
162162

163163
## Acknowledgements
164164

165165
Thank you to all of our wonderful contributors!
166166

167-
<a href="https://github.com/keras-team/keras-nlp/graphs/contributors">
168-
<img src="https://contrib.rocks/image?repo=keras-team/keras-nlp" />
167+
<a href="https://github.com/keras-team/keras-hub/graphs/contributors">
168+
<img src="https://contrib.rocks/image?repo=keras-team/keras-hub" />
169169
</a>

RELEASE_PROCESS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ Use the following steps to create an `X.Y.0` release.
2525
`rX.Y` for each minor release. We need to set this up.
2626

2727
If you have not, please set
28-
`upstream` as `keras-team/keras-nlp` by running:
28+
`upstream` as `keras-team/keras-hub` by running:
2929

3030
```shell
31-
git remote add upstream https://github.com/keras-team/keras-nlp.git
31+
git remote add upstream https://github.com/keras-team/keras-hub.git
3232
```
3333

3434
From the master branch, create a new branch with a name matching the first
@@ -48,7 +48,7 @@ Use the following steps to create an `X.Y.0` release.
4848
of the package. Development releases will have version numbers like
4949
`X.Y.0.dev0`, and critically will never be installed by default by `pip`.
5050

51-
Make a PR following [this template]([https://github.com/keras-team/keras-nlp/pull/456/files](https://github.com/keras-team/keras-nlp/pull/1638))
51+
Make a PR following [this template]([https://github.com/keras-team/keras-hub/pull/456/files](https://github.com/keras-team/keras-hub/pull/1638))
5252
to update the our version number fo look like `X.Y.0.dev0`. This PR should
5353
base off our new release branch instead of the master branch. You can use the
5454
following commands:
@@ -65,7 +65,7 @@ Use the following steps to create an `X.Y.0` release.
6565
branch, and ask someone to review.
6666

6767
3. On github, we can now create the `X.Y.0.dev0` release. Use
68-
[this link](https://github.com/keras-team/keras-nlp/releases/new) to kick it
68+
[this link](https://github.com/keras-team/keras-hub/releases/new) to kick it
6969
off.
7070

7171
This release should be titled `X.Y.0.dev0`, and create a new tag with the
@@ -162,7 +162,7 @@ to push certain fixes out to our users.
162162
of the package. Development releases will have version numbers like
163163
`X.Y.Z.dev0`, and critically will never be installed by default by `pip`.
164164

165-
Make a PR following [this template](https://github.com/keras-team/keras-nlp/pull/456/files)
165+
Make a PR following [this template](https://github.com/keras-team/keras-hub/pull/456/files)
166166
to update the our version number fo look like `X.Y.Z.dev0`. This PR should
167167
base off our new release branch. You can use the following commands.
168168

@@ -178,7 +178,7 @@ to push certain fixes out to our users.
178178
someone to review.
179179

180180
3. On github, we can now create the `X.Y.Z.dev0` release. Use
181-
[this link](https://github.com/keras-team/keras-nlp/releases/new).
181+
[this link](https://github.com/keras-team/keras-hub/releases/new).
182182

183183
This release should be titled `X.Y.Z.dev0`, and create a new tag with the
184184
same name on publish. Refer to the screenshot above for details on the

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ used before a patch is released.
77

88
You may submit the report in the following ways:
99

10-
- send a [private vulnerability report](https://github.com/keras-team/keras-nlp/security/advisories/new)
10+
- send a [private vulnerability report](https://github.com/keras-team/keras-hub/security/advisories/new)
1111

1212
Please provide the following information in your report:
1313

keras_hub/src/models/seq_2_seq_lm.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,4 @@ class Seq2SeqLM(CausalLM):
5151
```
5252
"""
5353

54-
# TODO: fill in during https://github.com/keras-team/keras-nlp/pull/1425
54+
# TODO: fill in during https://github.com/keras-team/keras-hub/pull/1425

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ def get_version(rel_path):
5050
long_description=README,
5151
long_description_content_type="text/markdown",
5252
version=VERSION,
53-
url="https://github.com/keras-team/keras-nlp",
53+
url="https://github.com/keras-team/keras-hub",
5454
author="Keras team",
5555
author_email="[email protected]",
5656
license="Apache License 2.0",

tools/checkpoint_training/bert_tiny_uncased_en_sst2_training.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
}
4646
],
4747
"source": [
48-
"!pip install -q git+https://github.com/keras-team/keras-nlp.git tensorflow --upgrade"
48+
"!pip install -q git+https://github.com/keras-team/keras-hub.git tensorflow --upgrade"
4949
]
5050
},
5151
{

0 commit comments

Comments
 (0)