Steps to get up and running:
git clone email@example.com:code-dot-org/ml-activities.git cd ml-activities nvm install nvm use npm install -g yarn yarn yarn start
At this point the app will be running at http://localhost:8080 with live-reloading on file changes.
Similar to https://github.com/code-dot-org/dance-party, ml-activities is built from a small repo as an app which is then used by the code.org dashboard to run individual levels in a script.
If you want to make changes locally in ml-activities and have them show up in your apps build, do the following:
- In the ml-activities root directory
- In the code-dot-org apps/ directory
yarn link @code-dot-org/ml-activitiesThis will set up a symlink in apps/node_modules/@code-dot-org to point at your local changes. Run
yarn buildin ml-activities, and then the code-dot-org apps build should pick up the changes (generated in ml-activities'
dist/) next time it occurs (including in already-running
yarn startbuild in code-dot-org).
- Note that ml-activities'
yarn startcan be left running when
yarn buildis run. But a new invocation of
yarn startwill intentionally clear the
dist/directory populated by
yarn buildto ensure we don't have outdated assets left in it.
- Note that ml-activities'
- If you want to go back to using the published module, in the code-dot-org apps/ directory run
yarn unlink @code-dot-org/ml-activities. You'll be given additional instructions on how to force the module to be rebuilt after that.
Adding new fish components
All fish components live in
public/images/fish in their respective folders (eg bodies live in
body/). Despite the fact that the fish face right in most of the tutorial, they are built as if they face left in order to simplify the math for the anchor points. This means that all components should be oriented as if the fish is facing left, which might require flopping any new assets. After adding the assets, they will need to be added to
bin/determineKnnData.js will output some of the lines that will be needed in
All components can define
exclusions, which are modes that the component won't be used in. Components appear in all modes by default.
Some components need more configuration:
Bodies need an anchor point for the body then all of the other components, relative to the bounds of the body image. A face anchor point is used for both the eyes and the mouth. The eyes and mouth are arranged with respect to each other and the defined anchor point. The tail Y anchor point is set from where the center of the component should be.
Some dorsal fins define an x-adjustment to shift the anchor point. This is useful for dorsal fins that might look odd is not positioned correctly (eg symmetical).
By default, this tutorial is in English. The strings live at i18n/oceans.json and should not be moved without corresponding changes to the I18n pipeline in
code-dot-org. Translations can be passed into the app using the
i18n param. If any translations are missing, the English string will be used as a default. This also means that adding a new string is safe and does not require any further steps.
Machine Learning algorithms
We currently have support for two machine learning algorithms: k nearest neighbor (KNN) and support vector machine (SVM). We also have a mobilenet model that is saved at
src/oceans/model.json (it's saved here to avoid a call to googleapis.com).