Skip to content

Commit 9fd1948

Browse files
author
Nikhil Thorat
authored
Cleanup markdown files after monorepo merge & add tfjs cloudbui… (#1812)
1 parent 81225ad commit 9fd1948

File tree

5 files changed

+97
-108
lines changed

5 files changed

+97
-108
lines changed

‎.gitignore

+15-27
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,21 @@
1-
node_modules/
2-
<<<<<<< HEAD
3-
package-lock.json
4-
npm-debug.log
1+
*.tgz
2+
**/*.pyc
3+
*/diff
54
.DS_Store
6-
dist/
7-
tensorflow-tfjs-*.tgz
8-
yarn-error.log
9-
.yalc/
10-
yalc.lock
5+
.idea/
116
.rpt2_cache/
12-
package
13-
release-notes.md
14-
=======
7+
.yalc/
8+
bazel-out/
159
coverage/
16-
npm-debug.log
17-
yarn-error.log
18-
local.log
19-
.DS_Store
2010
dist/
21-
bazel-out/
22-
.idea/
23-
*.tgz
24-
**/*.pyc
25-
.yalc/
26-
yalc.lock
27-
.rpt2_cache/
28-
package/
29-
*/diff
30-
11+
local.log
12+
package
13+
package-lock.json
14+
node_modules/
15+
npm-debug.log
16+
release-notes.md
17+
tensorflow-tfjs-*.tgz
3118
tfjs-backend-wasm/dist
3219
tfjs-backend-wasm/wasm-out
33-
>>>>>>> tfjs-core/master
20+
yalc.lock
21+
yarn-error.log

‎CONTRIBUTING.md

-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ You generally only need to submit a CLA once, so if you've already submitted one
1515
(even if it was for a different project), you probably don't need to do it
1616
again.
1717

18-
<<<<<<< HEAD
1918
## Code reviews
2019

2120
All submissions, including submissions by project members, require review. We
@@ -52,7 +51,6 @@ substantial it's better to discuss your design before submitting a PR.
5251
If you're looking for tasks to work on, we also mark issues as ["help wanted"](https://github.com/tensorflow/tfjs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
5352

5453

55-
=======
5654
## Adding functionality
5755

5856
One way to ensure that your PR will be accepted is to add functionality that
@@ -84,4 +82,3 @@ information on using pull requests.
8482

8583
We require unit tests for most code, instructions for running our unit test
8684
suites are in the documentation.
87-
>>>>>>> tfjs-core/master

‎DEVELOPMENT.md

+71-72
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,77 @@
11
## Development
22

3-
<<<<<<< HEAD
4-
This repository contains only the logic and scripts that combine
5-
two packages:
6-
- [TensorFlow.js Core](https://github.com/tensorflow/tfjs-core),
7-
a flexible low-level API, formerly known as *deeplearn.js*.
8-
- [TensorFlow.js Layers](https://github.com/tensorflow/tfjs-layers),
9-
a high-level API which implements functionality similar to
3+
This repository contains only the logic and scripts that combine the following NPM packages:
4+
- TensorFlow.js Core (@tensorflow/tfjs-core),
5+
a flexible low-level linear algebra and gradients API.
6+
- TensorFlow.js Layers (@tensorflow/tfjs-layers),
7+
a high-level model-centric API which implements functionality similar to
108
[Keras](https://keras.io/).
9+
- TensorFlow.js Converter (@tensorflow/tfjs-converter),
10+
a library to load converted TensorFlow SavedModels and execute them in JavaScript.
11+
- TensorFlow.js Data (@tensorflow/tfjs-data),
12+
a library to load and prepare data for use in machine learning models.
13+
14+
#### Yarn
15+
We use yarn, and if you are adding or removing dependencies you should use yarn
16+
to keep the `yarn.lock` file up to date.
17+
18+
#### Code editor
19+
We recommend using [Visual Studio Code](https://code.visualstudio.com/) for
20+
development. Make sure to install
21+
[TSLint VSCode extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-tslint-plugin)
22+
and the npm [clang-format](https://github.com/angular/clang-format) `1.2.2` or later
23+
with the
24+
[Clang-Format VSCode extension](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format)
25+
for auto-formatting.
26+
27+
#### Testing
28+
Before submitting a pull request, make sure the code passes all the tests and is clean of lint errors:
29+
30+
```bash
31+
# cd into the package directory you want to test
32+
$ yarn test
33+
$ yarn lint
34+
```
35+
36+
To run a subset of tests and/or on a specific browser:
37+
38+
```bash
39+
$ yarn test --browsers=Chrome --grep='multinomial'
40+
 
41+
> ...
42+
> Chrome 62.0.3202 (Mac OS X 10.12.6): Executed 28 of 1891 (skipped 1863) SUCCESS (6.914 secs / 0.634 secs)
43+
```
44+
45+
To run the tests once and exit the karma process (helpful on Windows):
46+
47+
```bash
48+
$ yarn test --single-run
49+
```
50+
51+
To run the tests in an environment that does not have GPU support (such as Chrome Remote Desktop):
52+
53+
```bash
54+
$ yarn test --testEnv cpu
55+
```
56+
57+
Available test environments: cpu, webgl1, webgl2.
58+
59+
#### Packaging (browser and npm)
60+
61+
In any of the directories the following commands build the NPM tarball:
62+
63+
```bash
64+
$ yarn build-npm
65+
> Stored standalone library at dist/tf-core(.min).js
66+
> Stored also tensorflow-tf-core-VERSION.tgz
67+
```
68+
69+
To install it locally, run `yarn add ./tensorflow-tf-core-VERSION.tgz`.
70+
71+
> On Windows, use bash (available through git) to use the scripts above.
72+
73+
Looking to contribute, and don't know where to start? Check out our "stat:contributions welcome" [issues](https://github.com/tensorflow/tfjs/labels/stat%3Acontributions%20welcome).
1174

12-
To develop:
13-
- `tfjs-core`, see [this doc](https://github.com/tensorflow/tfjs-core/blob/master/DEVELOPMENT.md).
14-
- `tfjs-layers` see [this doc](https://github.com/tensorflow/tfjs-layers/blob/master/DEVELOPMENT.md).
15-
- `tfjs` with locally modified `tfjs-layers` (or `tfjs-core`) see [this section](https://github.com/tensorflow/tfjs-layers/blob/master/DEVELOPMENT.md#changing-tensorflowtfjs-layers-and-testing-tensorflowtfjs) in [tfjs-layers/DEVELOPMENT.md](https://github.com/tensorflow/tfjs-layers) repo.
1675

1776
## For repository owners: commit style guide
1877

@@ -74,71 +133,11 @@ This will show up under "Features" as:
74133

75134
This will also show up under "Performance" as:
76135
- Improve matMul CPU speed by 100%. (Improvements to matMul.) (#900). Thanks, @externalcontributor.
77-
=======
78136
To build **TensorFlow.js Core API** from source, we need to clone the project and prepare
79137
the dev environment:
80138

81139
```bash
82140
$ git clone https://github.com/tensorflow/tfjs-core.git
83141
$ cd tfjs-core
84142
$ yarn # Installs dependencies.
85-
```
86-
87-
#### Yarn
88-
We use yarn, and if you are adding or removing dependencies you should use yarn
89-
to keep the `yarn.lock` file up to date.
90-
91-
#### Code editor
92-
We recommend using [Visual Studio Code](https://code.visualstudio.com/) for
93-
development. Make sure to install
94-
[TSLint VSCode extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-typescript-tslint-plugin)
95-
and the npm [clang-format](https://github.com/angular/clang-format) `1.2.2` or later
96-
with the
97-
[Clang-Format VSCode extension](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format)
98-
for auto-formatting.
99-
100-
#### Testing
101-
Before submitting a pull request, make sure the code passes all the tests and is clean of lint errors:
102-
103-
```bash
104-
$ yarn test
105-
$ yarn lint
106-
```
107-
108-
To run a subset of tests and/or on a specific browser:
109-
110-
```bash
111-
$ yarn test --browsers=Chrome --grep='multinomial'
112-
 
113-
> ...
114-
> Chrome 62.0.3202 (Mac OS X 10.12.6): Executed 28 of 1891 (skipped 1863) SUCCESS (6.914 secs / 0.634 secs)
115-
```
116-
117-
To run the tests once and exit the karma process (helpful on Windows):
118-
119-
```bash
120-
$ yarn test --single-run
121-
```
122-
123-
To run the tests in an environment that does not have GPU support (such as Chrome Remote Desktop):
124-
125-
```bash
126-
$ yarn test --testEnv cpu
127-
```
128-
129-
Available test environments: cpu, webgl1, webgl2.
130-
131-
#### Packaging (browser and npm)
132-
133-
```bash
134-
$ yarn build-npm
135-
> Stored standalone library at dist/tf-core(.min).js
136-
> Stored also tensorflow-tf-core-VERSION.tgz
137-
```
138-
139-
To install it locally, run `yarn add ./tensorflow-tf-core-VERSION.tgz`.
140-
141-
> On Windows, use bash (available through git) to use the scripts above.
142-
143-
Looking to contribute, and don't know where to start? Check out our "stat:contributions welcome" [issues](https://github.com/tensorflow/tfjs/labels/stat%3Acontributions%20welcome).
144-
>>>>>>> tfjs-core/master
143+
```

‎cloudbuild.yml

+10-3
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,27 @@ steps:
1515
# Core.
1616
- name: 'gcr.io/cloud-builders/gcloud'
1717
entrypoint: 'bash'
18-
id: 'core'
18+
id: 'tfjs-core'
1919
args: ['./scripts/run-build.sh', 'tfjs-core']
2020
waitFor: ['diff']
2121

22+
# Union.
23+
- name: 'gcr.io/cloud-builders/gcloud'
24+
entrypoint: 'bash'
25+
id: 'tfjs'
26+
args: ['./scripts/run-build.sh', 'tfjs']
27+
waitFor: ['diff']
28+
2229
# WebGPU.
2330
- name: 'gcr.io/cloud-builders/gcloud'
2431
entrypoint: 'bash'
25-
id: 'webgpu'
32+
id: 'tfjs-backend-webgpu'
2633
args: ['./scripts/run-build.sh', 'tfjs-webgpu']
2734
waitFor: ['diff']
2835

2936
# React Native.
3037
- name: 'gcr.io/cloud-builders/gcloud'
3138
entrypoint: 'bash'
32-
id: 'react-native'
39+
id: 'tfjs-react-native'
3340
args: ['./scripts/run-build.sh', 'tfjs-react-native']
3441
waitFor: ['diff']

‎pull_request_template.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
To see the logs from the Cloud Build CI, please join either
2-
our [discussion](https://groups.google.com/a/tensorflow.org/forum/#!forum/tfjs)
3-
or [announcement](https://groups.google.com/a/tensorflow.org/forum/#!forum/tfjs-announce) mailing list.
1+
To see the logs from the Cloud Build CI, please join either our [discussion](https://groups.google.com/a/tensorflow.org/forum/#!forum/tfjs) or [announcement](https://groups.google.com/a/tensorflow.org/forum/#!forum/tfjs-announce) mailing list.

0 commit comments

Comments
 (0)