Warn the user not to run the car examples.

StanfordASL · Apr 21, 2023 · 5c108c6 · 5c108c6
1 parent d7b03d3
commit 5c108c6
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/neural_network_lyapunov/examples/car/README.md b/neural_network_lyapunov/examples/car/README.md
@@ -0,0 +1,5 @@
+**Please do not run the code in this directory!!!!!**.
+
+We attempted to synthesize a neural-network controller for Dubins car with a Lyapunov function. Based on E.D.Sontag's [paper](https://arxiv.org/pdf/math/9902026.pdf), it is impossible to stabilize Dubins car with a continuous controller. Hence using a neural-network controller is doomed to fail.
+
+
diff --git a/neural_network_lyapunov/examples/car/train_acceleration_car_demo.py b/neural_network_lyapunov/examples/car/train_acceleration_car_demo.py
@@ -1,3 +1,8 @@
+"""
+Do not run this code!!!
+
+Dubins car cannot be stabilized by a continuous controller.
+"""
 import neural_network_lyapunov.examples.car.acceleration_car as\
     acceleration_car
 import neural_network_lyapunov.utils as utils

diff --git a/neural_network_lyapunov/examples/car/train_unicycle_demo.py b/neural_network_lyapunov/examples/car/train_unicycle_demo.py
@@ -1,3 +1,8 @@
+"""
+Do not run this code!!!!!
+
+Dubins car cannot be stabilized by a continuous controller.
+"""
 import neural_network_lyapunov.examples.car.unicycle as unicycle
 import neural_network_lyapunov.examples.car.unicycle_feedback_system as\
     unicycle_feedback_system
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,5 @@
		Please do not run the code in this directory!!!!!.

		We attempted to synthesize a neural-network controller for Dubins car with a Lyapunov function. Based on E.D.Sontag's [paper](https://arxiv.org/pdf/math/9902026.pdf), it is impossible to stabilize Dubins car with a continuous controller. Hence using a neural-network controller is doomed to fail.