ml5-next-gen

Welcome to the next-generation repo for the ml5.js project! Due to the complexities inherent in updating all the dependencies in the original repo, we're exploring rebuilding from the ground up. This fresh repository allows us to migrate over classes and functions one at a time. This is very much a work in progress and is currently in its early, experimental stage. We appreciate your patience as we work towards refining this next evolution of the ml5.js project. Stay tuned!

Setup

This build uses node version 18.15.0. We use Yarn instead of npm to help us better manage dependencies from TensorFlow.js. Yarn is a newer package manager that is very similar to NPM. Here is a cheat sheet for npm vs Yarn commands.

Install nvm and run the following commands：

nvm install 18.15
nvm use 18
npm install -g yarn

To start the development server, run the following commands:

yarn
yarn start

You should see something similar to this in the terminal:

[webpack-dev-server] Project is running at:
[webpack-dev-server] Loopback: http://localhost:8080/
...
...
webpack 5.76.1 compiled successfully in 8360 ms

A local server have been started and hosts a built version of the ml5 library at http://localhost:8080/dist/ml5.js. While the server is running, Webpack will automatically rebuild the library if you change and save any file in the /src folder.

A webpage at http://localhost:8080/examples/ should automatically open with the directory listing of the example directory. Select one of the directories to test run ml5.js in some example code.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Daniel Shiffman 💻 💡 📆 👀 ⚠️ 📹	Cristóbal Valenzuela 💻 💡 👀 🔧 ⚠️	Yining Shi 💻 💡 👀 🔧 ⚠️ 🐛	Hannah Davis 💻 💡	Joey Lee 💻 💡 👀 🖋 ⚠️	AshleyJaneLewis 📝 🎨 📋 🖋	Ellen Nickles 📝 🖋 🤔 ✅
Itay Niv 💻 💡	Nikita Huggins 📝 🖋 🤔	Arnab Chakravarty 🖋 📓	Aidan Nelson 💻 💡	WenheLI 💻 💡 🚧 🤔	Darius Kazemi 🤔 💬	Dingsu Wang 💻 💡
garym140 🖋 📝 🤔 📓	Gene Kogan 💻 💡 🤔	Hayley Hwang 💻 💡 🤔	Lisa Jamhoury 💡 🤔	Alejandro Matamala Ortiz 🎨 🖋 📝	Maya Man 💻 💡	Mimi Onuoha 🤔 🖋 👀
Yuuno, Hibiki 💻 💡 🚧	Dan Oved 💻 💡 💬 🤔	Stephanie Koltun 💻 💡 🖋 📝 🎨	YG Zhang 💻 💡 🤔	Wenqi Li 💻 💡 🚇	Brent Bailey ⚠️ 💻 💡	Jonarod 💻
Jasmine Otto 💻 ⚠️ 💡	Zaid Alyafeai 💻 💡 🤔 💬	Jacob Foster 💻 💡 ⚠️	Memo Akten 💻 💡	Mohamed Amine 💻 💡 🤔 ⚠️	Oliver Wright 💻 ⚠️	Marshal Hayes 📖
Reiichiro Nakano 💻 ⚠️ 💡	Nikhil Thorat 💻 💡 🤔 🚇	Irene Alvarado 💻 💡 🚧 🤔	Andrew Lee 💻 💡 🤔	Jerhone 📖	achimkoh 💻 💡 ⚠️	Jim 💡 📖 🖋
Junya Ishihara 🚧 💻	Naoto HIÉDA 🚧	aarón montoya-moraga 🚧 💡	b2renger 💻 🚇	Aditya Sharma 🚧	okuna291 🤔	Jenna 🤔
nicoleflloyd 🖋 🎨 📓	jepster-dk 💻 🤔	Xander Jake de los Santos 🤔	Cassie Tarakajian 🐛 🚇 🤔	Dave Briccetti 🐛	Sblob1 🐛	Jared Wilber 💡 🤔 💻
danilo 💻 🤔	Emma Goodliffe 🤔 💬 🚧	Yang 💻 🐛	Lydia Jessup 💻 🤔 💡	CJ R. 📖 🖋	Fabio Corona 🐛	Tobias Nickel 🐛 💻
Michael Salaverry 🖋 🐛	Rob 🐛 💬	Pujaa Rajan 💡 🐛	Nick McIntyre ⚠️ 🐛	Andy Baio 🖋 🚧	Wenqi Li 🖋 💻 🚇 🚧 🤔	garym140 🎨
Jim 🖋 🚧 🤔	Yeswanth 🚧 🐛	Pettrus Sherlock 🐛 🚧	danilo 🖋	Andreas Refsgaard 🖋	Brian Jordan 🖋	bradley inniss 🖋
Kaushlendra Pratap 🖋	maxdevjs 🖋	josher19 🖋 🐛	Frederik De Bleser 🖋	Violet 🐛	Tirta Wening Rachman 💻 🖋 🤔	Miká Kruschel 💻 🐛
Takanobu Asanuma 🖋	Martin L. Jensen 🖋	Hugo Romano 🖋	Darshan Sen 🖋	Ludwig Stumpp 👀 🐛 💡	Bomani Oseni McClendon 🖋 💻	Jang Haemin 🖋
Anton Filatov 🖋	Elijah Lucian 📖	Tam 🖋	RGV 💬	hansvana 🖋	Ali Karpuzoglu 🐛 🚧	Jacob Wysko 🖋
Dilwoar Hussain 📖	Manaswini Das 📖	Benjamin Botwin 👀 💬 🤔	Henrique Mota 👀 💬 🤔	CaseyPan 💻 🤔	Sam Tarakajian 💻 🐛 🚧 🤔	Michael Bell 📖 🐛 🚧
machenmusik 💡	Pranav Dudhane 📖	Tündi Szász 🎨 🤔	hellonun 🤔 📓	Pierre Grimaud 📖 🖋	Greg French 🐛	Dale Markowitz 💻 🤔
Ragland Asir 📖	Tom-Lucas Säger 📖	altruios 📖	mennosc 💻	neta 💻 📖	Koji 💻 📖	josephrocca 💻 📖
Lauren Lee McCarthy 💻 📖	Sorin Curescu 💻	mofanke 🐛 💻	Ikko Ashimine 📖	Mudasar-Makandar 🐛 💻	Amir Feqhi 💻	DasK 💻 🤔
Amir 💻 💡	lindapaiste 💻 🤔 🐛	Evan Weinberg 📖	Coder Gautam 📖	Yong-Yuan Chen 📖	adrianfiedler 📖 🐛	Micaelle Lages Lucena 📝 👥 📋
Vivian Chen 💻	ch3926 💻	Ziyuan Lin 💻 📖 💡 🚧	Ozioma Chukwukeme 📝 👥 📋	Zhuolin Li 💻 📖 🤔 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!