This repository was archived by the owner on Aug 15, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 945
Add rn integration test app #1874
Open
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
779fd46
Add integration test app.
tafsiri e718fea
Add readme
tafsiri aa42917
code review fixes
tafsiri 2d4e361
Merge branch 'master' into add-rn-integration-test-app
tafsiri 0ce4e95
add license
tafsiri 2d3f5fc
code review fixes and lint errors
tafsiri File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,3 +25,4 @@ tsconfig.json | |
| tslint.json | ||
| yarn-error.log | ||
| yarn.lock | ||
| integration_rn59 | ||
81 changes: 80 additions & 1 deletion
tfjs-react-native/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,82 @@ | ||
| # Platform Adapter for React Native | ||
|
|
||
| Status: Early development. | ||
| Status: __Early development__. This is still an unpublished experimental package. | ||
|
|
||
| ## Adapter Docs | ||
|
|
||
| TODO | ||
|
|
||
| ## Setting up a React Native app with tfjs-react-native | ||
|
|
||
| These instructions assume that you are generally familiar with [react native](https://facebook.github.io/react-native/) developement. This library has only been tested with React Native 0.58.X & 0.59.X. React Native 0.60 is not supported. | ||
|
|
||
| ### Step 1. Create your react native app. | ||
|
|
||
| You can use the [React Native CLI](https://facebook.github.io/react-native/docs/getting-started) or [Expo](https://expo.io/). This library relies on a couple of dependencies from the Expo project so it may be convenient to use expo but is not mandatory. | ||
|
|
||
| On macOS (to develop iOS applications) You will also need to use Cocoapods to install these dependencies. | ||
|
|
||
| ### Step 2: Install expo related libraries | ||
|
|
||
| Depending on which workflow you used to set up your app you will need to install different dependencies. | ||
|
|
||
| - React Native CLI App | ||
| - Install and configure [react-native-unimodules](https://github.com/unimodules/react-native-unimodules) | ||
| - Install and configure [expo-gl-cpp](https://github.com/expo/expo/tree/master/packages/expo-gl-cpp) and [expo-gl](https://github.com/expo/expo/tree/master/packages/expo-gl) | ||
| - Expo Bare App | ||
| - Install and configure [expo-gl-cpp](https://github.com/expo/expo/tree/master/packages/expo-gl-cpp) and [expo-gl](https://github.com/expo/expo/tree/master/packages/expo-gl) | ||
| - Expo Managed App | ||
| - Install and configure [expo-gl](https://github.com/expo/expo/tree/master/packages/expo-gl) | ||
|
|
||
|
|
||
| Note if in a _managed_ expo application these libraries should be present and you should be able to skip this step. | ||
|
|
||
| Install and configure [react-native-unimodules](https://github.com/unimodules/react-native-unimodules) | ||
| Install and configure [expo-gl-cpp](https://github.com/expo/expo/tree/master/packages/expo-gl-cpp) and [expo-gl](https://github.com/expo/expo/tree/master/packages/expo-gl) | ||
|
|
||
| > After this point, if you are using XCode to build for ios, you should use a ‘.workspace’ file instead of the ‘.xcodeproj’ | ||
|
|
||
| ### Step 3: Configure [Metro](https://facebook.github.io/metro/en/) | ||
|
|
||
| Edit your `metro.config.js` to look like the following. Changes are noted in | ||
| the comments below. | ||
|
|
||
| ```js | ||
| // Change 1 | ||
| const blacklist = require('metro-config/src/defaults/blacklist'); | ||
|
|
||
| module.exports = { | ||
| transformer: { | ||
| getTransformOptions: async () => ({ | ||
| transform: { | ||
| experimentalImportSupport: false, | ||
| inlineRequires: false, | ||
| }, | ||
| }), | ||
| }, | ||
| resolver: { | ||
| // Change 2 (add 'bin' to assetExts) | ||
| assetExts: ['bin', 'txt', 'jpg'], | ||
| sourceExts: ['js', 'json', 'ts', 'tsx', 'jsx'], | ||
| // Change 3 | ||
| blacklistRE: blacklist([/platform_node/]) | ||
| }, | ||
| }; | ||
| ``` | ||
|
|
||
|
|
||
| ### Step 4: Install TensorFlow.js and tfjs-react-native | ||
|
|
||
| - Install @tensorflow/tfjs - `npm install @tensorflow/tfjs` | ||
| - Install @tensorflow/tfjs-react-native - coming soon | ||
|
|
||
| ### Step 5: Test that it is working | ||
|
|
||
| TODO: Add some sample code. | ||
|
|
||
| For now take a look at `integration_rn59/App.tsx` for an example of what using tfjs-react-native looks like. | ||
|
|
||
| ### Optional Steps | ||
|
|
||
| If you want use the `AsyncStorageHandler` to save and load models, add [async-storage](https://github.com/react-native-community/async-storage) to your project. | ||
|
|
6 changes: 6 additions & 0 deletions
tfjs-react-native/integration_rn59/.buckconfig
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
|
|
||
| [android] | ||
| target = Google Inc.:Google APIs:23 | ||
|
|
||
| [maven_repositories] | ||
| central = https://repo1.maven.org/maven2 |
1 change: 1 addition & 0 deletions
tfjs-react-native/integration_rn59/.gitattributes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| *.pbxproj -text |
63 changes: 63 additions & 0 deletions
tfjs-react-native/integration_rn59/.gitignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # OSX | ||
| # | ||
| .DS_Store | ||
|
|
||
| # Xcode | ||
| # | ||
| build/ | ||
| *.pbxuser | ||
| !default.pbxuser | ||
| *.mode1v3 | ||
| !default.mode1v3 | ||
| *.mode2v3 | ||
| !default.mode2v3 | ||
| *.perspectivev3 | ||
| !default.perspectivev3 | ||
| xcuserdata | ||
| *.xccheckout | ||
| *.moved-aside | ||
| DerivedData | ||
| *.hmap | ||
| *.ipa | ||
| *.xcuserstate | ||
| project.xcworkspace | ||
|
|
||
| # Android/IntelliJ | ||
| # | ||
| build/ | ||
| .idea | ||
| .gradle | ||
| local.properties | ||
| *.iml | ||
|
|
||
| # Visual Studio Code | ||
| # | ||
| .vscode/ | ||
|
|
||
| # node.js | ||
| # | ||
| node_modules/ | ||
| npm-debug.log | ||
| yarn-error.log | ||
|
|
||
| # BUCK | ||
| buck-out/ | ||
| \.buckd/ | ||
| *.keystore | ||
|
|
||
| # fastlane | ||
| # | ||
| # It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the | ||
| # screenshots whenever they are needed. | ||
| # For more information about the recommended setup visit: | ||
| # https://docs.fastlane.tools/best-practices/source-control/ | ||
|
|
||
| */fastlane/report.xml | ||
| */fastlane/Preview.html | ||
| */fastlane/screenshots | ||
|
|
||
| # Bundle artifact | ||
| *.jsbundle | ||
|
|
||
| # CocoaPods | ||
| /ios/Pods/ |
163 changes: 163 additions & 0 deletions
tfjs-react-native/integration_rn59/App.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2019 Google LLC. All Rights Reserved. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * ============================================================================= | ||
| */ | ||
|
|
||
| import React, { Fragment } from 'react'; | ||
| import { Button, SafeAreaView, StyleSheet, ScrollView, View, Text, StatusBar } from 'react-native'; | ||
|
|
||
| import * as tf from '@tensorflow/tfjs'; | ||
| import '@tensorflow/tfjs-react-native'; | ||
|
|
||
| import { Diagnostic } from './components/diagnostic'; | ||
| import { MobilenetDemo } from './components/mobilenet_demo'; | ||
|
|
||
| export type Screen = 'main' | 'diag' | 'demo'; | ||
|
|
||
| interface AppState { | ||
| isTfReady: boolean; | ||
| currentScreen: Screen; | ||
| } | ||
|
|
||
| export class App extends React.Component<{}, AppState> { | ||
| constructor(props: {}) { | ||
| super(props); | ||
| this.state = { | ||
| isTfReady: false, | ||
| currentScreen: 'main' | ||
| }; | ||
|
|
||
| this.showDiagnosticScreen = this.showDiagnosticScreen.bind(this); | ||
| this.showDemoScreen = this.showDemoScreen.bind(this); | ||
| this.showMainScreen = this.showMainScreen.bind(this); | ||
| } | ||
|
|
||
| async componentDidMount() { | ||
| await tf.setBackend('rn-webgl'); | ||
| await tf.ready(); | ||
| this.setState({ | ||
| isTfReady: true, | ||
| }); | ||
| } | ||
|
|
||
| showDiagnosticScreen() { | ||
| this.setState({ currentScreen: 'diag' }); | ||
| } | ||
|
|
||
| showDemoScreen() { | ||
| this.setState({ currentScreen: 'demo' }); | ||
| } | ||
|
|
||
| showMainScreen() { | ||
| this.setState({ currentScreen: 'main' }); | ||
| } | ||
|
|
||
| renderMainScreen() { | ||
| return <Fragment> | ||
| <View style={styles.sectionContainer}> | ||
| <Text style={styles.sectionTitle}>Diagnostic</Text> | ||
| <Button | ||
| onPress={this.showDiagnosticScreen} | ||
| title='Show Diagnostic Screen' | ||
| /> | ||
| </View> | ||
| <View style={styles.sectionContainer}> | ||
| <Text style={styles.sectionTitle}>Demo</Text> | ||
| <Button | ||
| onPress={this.showDemoScreen} | ||
| title='Show Demo Screen' | ||
| /> | ||
| </View> | ||
| </Fragment>; | ||
| } | ||
|
|
||
| renderDiagnosticScreen() { | ||
| return <Fragment> | ||
| <Diagnostic returnToMain={this.showMainScreen} /> | ||
| </Fragment>; | ||
| } | ||
|
|
||
| renderDemoScreen() { | ||
| const image = require('./assets/images/catsmall.jpg'); | ||
| return <Fragment> | ||
| <MobilenetDemo | ||
| image={image} | ||
| returnToMain={this.showMainScreen} /> | ||
| </Fragment>; | ||
| } | ||
|
|
||
| renderLoadingTF() { | ||
| return <Fragment> | ||
| <View style={styles.sectionContainer}> | ||
| <Text style={styles.sectionTitle}>Loading TF</Text> | ||
| </View> | ||
| </Fragment>; | ||
| } | ||
|
|
||
| renderContent() { | ||
| const { currentScreen, isTfReady } = this.state; | ||
| if (isTfReady) { | ||
| switch (currentScreen) { | ||
| case 'main': | ||
| return this.renderMainScreen(); | ||
| case 'diag': | ||
| return this.renderDiagnosticScreen(); | ||
| case 'demo': | ||
| return this.renderDemoScreen(); | ||
| default: | ||
| return this.renderMainScreen(); | ||
| } | ||
| } else { | ||
| return this.renderLoadingTF(); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| render() { | ||
| return ( | ||
| <Fragment> | ||
| <StatusBar barStyle='dark-content' /> | ||
| <SafeAreaView> | ||
| <ScrollView | ||
| contentInsetAdjustmentBehavior='automatic' | ||
| style={styles.scrollView}> | ||
| <View style={styles.body}> | ||
| {this.renderContent()} | ||
| </View> | ||
| </ScrollView> | ||
| </SafeAreaView> | ||
| </Fragment> | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| const styles = StyleSheet.create({ | ||
| scrollView: { | ||
| backgroundColor: 'white', | ||
| }, | ||
| body: { | ||
| backgroundColor: 'white', | ||
| }, | ||
| sectionContainer: { | ||
| marginTop: 32, | ||
| paddingHorizontal: 24, | ||
| }, | ||
| sectionTitle: { | ||
| fontSize: 24, | ||
| fontWeight: '600', | ||
| color: 'black', | ||
| marginBottom: 6, | ||
| }, | ||
| }); |
3 changes: 3 additions & 0 deletions
tfjs-react-native/integration_rn59/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| This is an app that serves and an integration testbed for tfjs-react-native. | ||
|
|
||
| For more info please see the [README](../README.md) in the folder above this one. |
55 changes: 55 additions & 0 deletions
tfjs-react-native/integration_rn59/android/app/BUCK
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # To learn about Buck see [Docs](https://buckbuild.com/). | ||
| # To run your application with Buck: | ||
| # - install Buck | ||
| # - `npm start` - to start the packager | ||
| # - `cd android` | ||
| # - `keytool -genkey -v -keystore keystores/debug.keystore -storepass android -alias androiddebugkey -keypass android -dname "CN=Android Debug,O=Android,C=US"` | ||
| # - `./gradlew :app:copyDownloadableDepsToLibs` - make all Gradle compile dependencies available to Buck | ||
| # - `buck install -r android/app` - compile, install and run application | ||
| # | ||
|
|
||
| load(":build_defs.bzl", "create_aar_targets", "create_jar_targets") | ||
|
|
||
| lib_deps = [] | ||
|
|
||
| create_aar_targets(glob(["libs/*.aar"])) | ||
|
|
||
| create_jar_targets(glob(["libs/*.jar"])) | ||
|
|
||
| android_library( | ||
| name = "all-libs", | ||
| exported_deps = lib_deps, | ||
| ) | ||
|
|
||
| android_library( | ||
| name = "app-code", | ||
| srcs = glob([ | ||
| "src/main/java/**/*.java", | ||
| ]), | ||
| deps = [ | ||
| ":all-libs", | ||
| ":build_config", | ||
| ":res", | ||
| ], | ||
| ) | ||
|
|
||
| android_build_config( | ||
| name = "build_config", | ||
| package = "com.integration_rn59", | ||
| ) | ||
|
|
||
| android_resource( | ||
| name = "res", | ||
| package = "com.integration_rn59", | ||
| res = "src/main/res", | ||
| ) | ||
|
|
||
| android_binary( | ||
| name = "app", | ||
| keystore = "//android/keystores:debug", | ||
| manifest = "src/main/AndroidManifest.xml", | ||
| package_type = "debug", | ||
| deps = [ | ||
| ":app-code", | ||
| ], | ||
| ) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.