Skip to content

Conversation

Robert-Jia00129
Copy link
Contributor

@Robert-Jia00129 Robert-Jia00129 commented Oct 20, 2025

Added quickstart tutorial for Python. Created a quickstart notebook that help new users quickly learn basic concepts and implementation in ~10 minutes.

Major topics:

  • how gtsam variables are represented
  • how to create variables
  • how to print/display variable
  • how to use FactorGraphs
  • conditional probabilities
  • sampling and assigning variables

Need helps -- TODO:

  • I'm not sure how to add this to the docs pages at https://borglab.github.io/gtsam/
  • Upload to colab (but probably not under my name)

@dellaert
Copy link
Member

Nice, Robert!

  • I'd not market it as a python tutorial for gtsam, per se, but as an example.
  • I'd put this in the python/gtsam/examples folder, along with other examples, and call it DiscreteMotionModel.ipynb or something. It will automatically appear.
  • You probably want to refer people to the online book, as that's where it's coming from
  • Finally, look at 6 More Python Examples + Standardized Notebook Format #2288 - it has a handy script to add the "standard" cells at the beginning of an example. That will also install the "open in colab" button

@Robert-Jia00129
Copy link
Contributor Author

  • I'd not market it as a python tutorial for gtsam, per se, but as an example.

  • I'd put this in the python/gtsam/examples folder, along with other examples, and call it DiscreteMotionModel.ipynb or something. It will automatically appear.

  • You probably want to refer people to the online book, as that's where it's coming from

  • Yes. I referred to it in the guide in several places. I'll refer to it in the very beginning as well.

  • Finally, look at 6 More Python Examples + Standardized Notebook Format #2288 - it has a handy script to add the "standard" cells at the beginning of an example. That will also install the "open in colab" button

  • I saw the Python script. We should probably also bring it into develop branch.

@dellaert dellaert self-requested a review October 21, 2025 17:14
@Robert-Jia00129
Copy link
Contributor Author

@dellaert Just updated the image path. It should be good now. I'll try putting everything in the examples folder so we don't waste the extra resources :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants