• Stars
    star
    185
  • Rank 208,271 (Top 5 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 2 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🎒 Creating and sharing simulation environments for embodied and synthetic data research



GitHub GitHub release Contributor Covenant

Simulate

Note: The library is not actively maintained / built, if you want to contribute, please open an issue.

Simulate is a library for easily creating and sharing simulation environments for intelligent agents (e.g. reinforcement learning) or synthetic data generation.

Install

Install Simulate (preferentially in a virtual environment) with a simple pip install simulate Note: vtk is not built for Apple Silicon with Python 3.8. Please install with >3.9 in that case.

Install for contribution (from CONTRIBUTING.md)

Create a virtual env and then install the code style/quality tools as well as the code base locally

pip install --upgrade simulate

Before you merge a PR, fix the style (we use isort + black)

make style

Quick tour

Simulate's API is inspired by the great Kubric's API. The user create a Scene and add Assets in it (objects, cameras, lights etc).

Once the scene is created, you can save and share it as a file. This is a gIFT file, aka a JSON file with associated resources.

You can also render the scene or do simulations using one of the backend rendering/simulation engines (at the moment Unity, Blender and Godot).

The saving/sharing format is engine agnostic and using a graphic industry standard.

Let's do a quick exploration together.

import simulate as sm

scene = sm.Scene()

Project Structure

The Python API is located in src/simulate. It allows creation and loading of scenes, and sending commands to the backend.

We provide several backends to render and/or run the scene. The default backend requires no specific installation and is based on pyvista. It allows one to quick render/explored scene but doesn't handle physics simulation. To allow physic simulations, the Unity backend can for instance be used by setting engine="unity" (and soon the Godot and Blender Engines backend as well). A Unity build will be automatically downloaded (if not already) and spawed to run simulations. Alternatively, one can download and use the Unity editor themself, which must then be opened with Unity version 2021.3.2f1.

Loading a scene from the Hub or a local file

Loading a scene from a local file or the Hub is done with Scene.create_from(), saving locally or pushing to the Hub with scene.save() or scene.push_to_hub():

from simulate import Scene

scene = Scene.create_from('tests/test_assets/fixtures/Box.gltf')  # either local (priority) or on the Hub with full path to file
scene = Scene.create_from('simulate-tests/Box/glTF/Box.gltf', is_local=False)  # Set priority to the Hub file

scene.save('local_dir/file.gltf')  # Save to a local file
scene.push_to_hub('simulate-tests/Debug/glTF/Box.gltf')  # Save to the Hub - use a token if necessary

scene.show()



Creating a Scene and adding/managing Objects in the scene

Basic example of creating a scene with a plane and a sphere above it:

import simulate as sm

scene = sm.Scene()
scene += sm.Plane() + sm.Sphere(position=[0, 1, 0], radius=0.2)

>>> scene
>>> Scene(dimensionality=3, engine='PyVistaEngine')
>>> └── plane_01 (Plane - Mesh: 121 points, 100 cells)
>>>     └── sphere_02 (Sphere - Mesh: 842 points, 870 cells)

scene.show()

An object (as well as the Scene) is just a node in a tree provided with optional mesh (under the hood created/stored/edited as a pyvista.PolyData or pyvista.MultiBlock objects) and material and/or light, camera, agents special objects.

The following objects creation helpers are currently provided:

  • Object3D any object with a mesh and/or material
  • Plane
  • Sphere
  • Capsule
  • Cylinder
  • Box
  • Cone
  • Line
  • MultipleLines
  • Tube
  • Polygon
  • Ring
  • Text3D
  • Triangle
  • Rectangle
  • Circle
  • StructuredGrid
  • ... (see the doc)

Many of these objects can be visualized by running the following example:

python examples/basic/objects.py



Objects are organized in a tree structure

Adding/removing objects:

  • Using the addition (+) operator (or alternatively the method .add(object)) will add an object as a child of a previous object.
  • Objects can be removed with the subtraction (-) operator or the .remove(object) command.
  • Several objects can be added at once by adding a list/tuple to the scene.
  • The whole scene can be cleared with .clear().
  • To add a nested object, just add it to the object under which it should be nested, e.g. scene.sphere += sphere_child.

Accessing objects:

  • Objects can be directly accessed as attributes of their parents using their names (given with name attribute at creation or automatically generated from the class name + creation counter).
  • Objects can also be accessed from their names with .get_node(name).
  • The names of the object are enforced to be unique (on save/show).
  • Various tree_* attributes are available on any node to quickly navegate or list part of the tree of nodes.

Here are a couple of examples of manipulations:

# Add two copy of the sphere to the scene as children of the root node (using list will add all objects on the same level)
# Using `.copy()` will create a copy of an object (the copy doesn't have any parent or children)
scene += [scene.plane_01.sphere_02.copy(), scene.plane_01.sphere_02.copy()]

>>> scene
>>> Scene(dimensionality=3, engine='pyvista')
>>> β”œβ”€β”€ plane_01 (Plane - Mesh: 121 points, 100 cells)
>>> β”‚   └── sphere_02 (Sphere - Mesh: 842 points, 870 cells)
>>> β”œβ”€β”€ sphere_03 (Sphere - Mesh: 842 points, 870 cells)
>>> └── sphere_04 (Sphere - Mesh: 842 points, 870 cells)

# Remove the last added sphere
>>> scene.remove(scene.sphere_04)
>>> Scene(dimensionality=3, engine='pyvista')
>>> β”œβ”€β”€ plane_01 (Plane - Mesh: 121 points, 100 cells)
>>> β”‚   └── sphere_02 (Sphere - Mesh: 842 points, 870 cells)
>>> └── sphere_03 (Sphere - Mesh: 842 points, 870 cells)

Editing and moving objects

Objects can be easily translated, rotated, scaled

Here are a couple of examples:

# Let's translate our floor (with the first sphere, it's child)
scene.plane_01.translate_x(1)

# Let's scale the second sphere uniformly
scene.sphere_03.scale(0.1)

# Inspect the current position and scaling values
print(scene.plane_01.position)
>>> array([1., 0., 0.])
print(scene.sphere_03.scaling)
>>> array([0.1, 0.1, 0.1])

# We can also translate from a vector and rotate from a quaternion or along the various axis

Editing objects:

  • mesh of the object can be edited with all the manipulation operator provided by pyvista

Visualization engine

A default visualization engine is provided with the vtk backend of pyvista.

Starting the visualization engine can be done simply with .show().

scene.show()

You can find bridges to other rendering/simulation engines in the integrations directory.

Tips

If you are running on GCP, remember not to install pyvistaqt, and if you did so, uninstall it in your environment, since QT doesn't work well on GCP.

Citation

@misc{simulate,
  author = {Thomas Wolf, Edward Beeching, Carl Cochet, Dylan Ebert, Alicia Machado, Nathan Lambert, ClΓ©ment Romac},
  title = {Simulate},
  year = {2022},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/huggingface/simulate}}
}

More Repositories

1

transformers

πŸ€— Transformers: State-of-the-art Machine Learning for Pytorch, TensorFlow, and JAX.
Python
133,705
star
2

pytorch-image-models

PyTorch image models, scripts, pretrained weights -- ResNet, ResNeXT, EfficientNet, NFNet, Vision Transformer (ViT), MobileNet-V3/V2, RegNet, DPN, CSPNet, Swin Transformer, MaxViT, CoAtNet, ConvNeXt, and more
Python
28,073
star
3

diffusers

πŸ€— Diffusers: State-of-the-art diffusion models for image and audio generation in PyTorch and FLAX.
Python
25,619
star
4

datasets

πŸ€— The largest hub of ready-to-use datasets for ML models with fast, easy-to-use and efficient data manipulation tools
Python
17,530
star
5

peft

πŸ€— PEFT: State-of-the-art Parameter-Efficient Fine-Tuning.
Python
15,663
star
6

candle

Minimalist ML framework for Rust
Rust
15,011
star
7

trl

Train transformer language models with reinforcement learning.
Python
9,850
star
8

text-generation-inference

Large Language Model Text Generation Inference
Python
8,939
star
9

tokenizers

πŸ’₯ Fast State-of-the-Art Tokenizers optimized for Research and Production
Rust
8,885
star
10

accelerate

πŸš€ A simple way to launch, train, and use PyTorch models on almost any device and distributed configuration, automatic mixed precision (including fp8), and easy-to-configure FSDP and DeepSpeed support
Python
7,854
star
11

chat-ui

Open source codebase powering the HuggingChat app
TypeScript
7,113
star
12

lerobot

πŸ€— LeRobot: Making AI for Robotics more accessible with end-to-end learning
Python
6,522
star
13

alignment-handbook

Robust recipes to align language models with human and AI preferences
Python
4,474
star
14

parler-tts

Inference and training library for high-quality TTS models.
Python
4,027
star
15

autotrain-advanced

πŸ€— AutoTrain Advanced
Python
3,925
star
16

deep-rl-class

This repo contains the syllabus of the Hugging Face Deep Reinforcement Learning Course.
MDX
3,680
star
17

diffusion-models-class

Materials for the Hugging Face Diffusion Models Course
Jupyter Notebook
3,508
star
18

notebooks

Notebooks using the Hugging Face libraries πŸ€—
Jupyter Notebook
3,492
star
19

distil-whisper

Distilled variant of Whisper for speech recognition. 6x faster, 50% smaller, within 1% word error rate.
Python
3,455
star
20

neuralcoref

✨Fast Coreference Resolution in spaCy with Neural Networks
C
2,842
star
21

safetensors

Simple, safe way to store and distribute tensors
Python
2,754
star
22

text-embeddings-inference

A blazing fast inference solution for text embeddings models
Rust
2,746
star
23

knockknock

πŸšͺ✊Knock Knock: Get notified when your training ends with only two additional lines of code
Python
2,682
star
24

speech-to-speech

Speech To Speech: an effort for an open-sourced and modular GPT4-o
Python
2,540
star
25

swift-coreml-diffusers

Swift app demonstrating Core ML Stable Diffusion
Swift
2,506
star
26

optimum

πŸš€ Accelerate training and inference of πŸ€— Transformers and πŸ€— Diffusers with easy to use hardware optimization tools
Python
2,469
star
27

blog

Public repo for HF blog posts
Jupyter Notebook
2,303
star
28

setfit

Efficient few-shot learning with Sentence Transformers
Jupyter Notebook
2,142
star
29

course

The Hugging Face course on Transformers
MDX
2,005
star
30

awesome-papers

Papers & presentation materials from Hugging Face's internal science day
1,996
star
31

datatrove

Freeing data processing from scripting madness by providing a set of platform-agnostic customizable pipeline processing blocks.
Python
1,909
star
32

evaluate

πŸ€— Evaluate: A library for easily evaluating machine learning models and datasets.
Python
1,825
star
33

cookbook

Open-source AI cookbook
Jupyter Notebook
1,660
star
34

transfer-learning-conv-ai

πŸ¦„ State-of-the-Art Conversational AI with Transfer Learning
Python
1,654
star
35

swift-coreml-transformers

Swift Core ML 3 implementations of GPT-2, DistilGPT-2, BERT, and DistilBERT for Question answering. Other Transformers coming soon!
Swift
1,543
star
36

pytorch-openai-transformer-lm

πŸ₯A PyTorch implementation of OpenAI's finetuned transformer language model with a script to import the weights pre-trained by OpenAI
Python
1,464
star
37

huggingface.js

Utilities to use the Hugging Face Hub API
TypeScript
1,368
star
38

Mongoku

πŸ”₯The Web-scale GUI for MongoDB
TypeScript
1,313
star
39

huggingface_hub

All the open source things related to the Hugging Face Hub.
Python
1,311
star
40

gsplat.js

JavaScript Gaussian Splatting library.
TypeScript
1,302
star
41

llm-vscode

LLM powered development for VSCode
TypeScript
1,206
star
42

hmtl

🌊HMTL: Hierarchical Multi-Task Learning - A State-of-the-Art neural network model for several NLP tasks based on PyTorch and AllenNLP
Python
1,185
star
43

nanotron

Minimalistic large language model 3D-parallelism training
Python
1,071
star
44

pytorch-pretrained-BigGAN

πŸ¦‹A PyTorch implementation of BigGAN with pretrained weights and conversion scripts.
Python
986
star
45

optimum-nvidia

Python
888
star
46

torchMoji

πŸ˜‡A pyTorch implementation of the DeepMoji model: state-of-the-art deep learning model for analyzing sentiment, emotion, sarcasm etc
Python
880
star
47

awesome-huggingface

πŸ€— A list of wonderful open-source projects & applications integrated with Hugging Face libraries.
853
star
48

optimum-quanto

A pytorch quantization backend for optimum
Python
738
star
49

llm.nvim

LLM powered development for Neovim
Lua
728
star
50

naacl_transfer_learning_tutorial

Repository of code for the tutorial on Transfer Learning in NLP held at NAACL 2019 in Minneapolis, MN, USA
Python
718
star
51

dataset-viewer

Backend that powers the dataset viewer on Hugging Face dataset pages through a public API.
Python
689
star
52

swift-transformers

Swift Package to implement a transformers-like API in Swift
Swift
647
star
53

exporters

Export Hugging Face models to Core ML and TensorFlow Lite
Python
587
star
54

llm-ls

LSP server leveraging LLMs for code completion (and more?)
Rust
586
star
55

ratchet

A cross-platform browser ML framework.
Rust
574
star
56

transformers-bloom-inference

Fast Inference Solutions for BLOOM
Python
557
star
57

lighteval

LightEval is a lightweight LLM evaluation suite that Hugging Face has been using internally with the recently released LLM data processing library datatrove and LLM training library nanotron.
Python
554
star
58

pytorch_block_sparse

Fast Block Sparse Matrices for Pytorch
C++
523
star
59

node-question-answering

Fast and production-ready question answering in Node.js
TypeScript
459
star
60

large_language_model_training_playbook

An open collection of implementation tips, tricks and resources for training large language models
Python
452
star
61

swift-chat

Mac app to demonstrate swift-transformers
Swift
444
star
62

llm_training_handbook

An open collection of methodologies to help with successful training of large language models.
Python
437
star
63

text-clustering

Easily embed, cluster and semantically label text datasets
Python
422
star
64

cosmopedia

Python
416
star
65

optimum-intel

πŸ€— Optimum Intel: Accelerate inference with Intel optimization tools
Jupyter Notebook
393
star
66

controlnet_aux

Python
386
star
67

community-events

Place where folks can contribute to πŸ€— community events
Jupyter Notebook
368
star
68

tflite-android-transformers

DistilBERT / GPT-2 for on-device inference thanks to TensorFlow Lite with Android demo apps
Java
368
star
69

nn_pruning

Prune a model while finetuning or training.
Jupyter Notebook
360
star
70

speechbox

Python
341
star
71

100-times-faster-nlp

πŸš€100 Times Faster Natural Language Processing in Python - iPython notebook
HTML
325
star
72

education-toolkit

Educational materials for universities
Jupyter Notebook
324
star
73

transformers.js-examples

A collection of πŸ€— Transformers.js demos and example applications
JavaScript
323
star
74

open-muse

Open reproduction of MUSE for fast text2image generation.
Python
320
star
75

local-gemma

Gemma 2 optimized for your local machine.
Python
317
star
76

unity-api

C#
313
star
77

audio-transformers-course

The Hugging Face Course on Transformers for Audio
MDX
308
star
78

datablations

Scaling Data-Constrained Language Models
Jupyter Notebook
305
star
79

hf_transfer

Rust
287
star
80

dataspeech

Python
262
star
81

huggingface-llama-recipes

Jupyter Notebook
259
star
82

optimum-benchmark

πŸ‹οΈ A unified multi-backend utility for benchmarking Transformers, Timm, PEFT, Diffusers and Sentence-Transformers with full support of Optimum's hardware optimizations & quantization schemes.
Python
245
star
83

diarizers

Python
238
star
84

hub-docs

Docs of the Hugging Face Hub
221
star
85

llm-swarm

Manage scalable open LLM inference endpoints in Slurm clusters
Python
216
star
86

sam2-studio

Swift
196
star
87

optimum-neuron

Easy, fast and very cheap training and inference on AWS Trainium and Inferentia chips.
Jupyter Notebook
193
star
88

data-is-better-together

Let's build better datasets, together!
Jupyter Notebook
192
star
89

instruction-tuned-sd

Code for instruction-tuning Stable Diffusion.
Python
189
star
90

OBELICS

Code used for the creation of OBELICS, an open, massive and curated collection of interleaved image-text web documents, containing 141M documents, 115B text tokens and 353M images.
Python
184
star
91

diffusion-fast

Faster generation with text-to-image diffusion models.
Python
179
star
92

olm-datasets

Pipeline for pulling and processing online language model pretraining data from the web
Python
173
star
93

api-inference-community

Python
161
star
94

jat

General multi-task deep RL Agent
Python
154
star
95

workshops

Materials for workshops on the Hugging Face ecosystem
Jupyter Notebook
148
star
96

coreml-examples

Swift Core ML Examples
Jupyter Notebook
147
star
97

optimum-habana

Easy and lightning fast training of πŸ€— Transformers on Habana Gaudi processor (HPU)
Python
147
star
98

chug

Minimal sharded dataset loaders, decoders, and utils for multi-modal document, image, and text datasets.
Python
140
star
99

sharp-transformers

A Unity plugin for using Transformers models in Unity.
C#
139
star
100

hf-hub

Rust client for the huggingface hub aiming for minimal subset of features over `huggingface-hub` python package
Rust
132
star