Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small changes to using_manifolds.md docs #834

Merged
merged 1 commit into from
Apr 5, 2022

Conversation

mateuszbaran
Copy link
Contributor

I've made a few small changes to using_manifold.md -- let me know what you think 🙂

I've made a few small changes to `using_manifold.md` -- let me know what you think 🙂
Copy link
Member

@dehann dehann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that's awesome thanks!

@dehann dehann added this to the v0.12.1 milestone Apr 5, 2022
@dehann dehann merged commit 8af4d9d into JuliaRobotics:master Apr 5, 2022
@dehann
Copy link
Member

dehann commented Apr 5, 2022

I take it from the few changes that you don't have terrible disagreement on the content of the overall page :-) Style is more lighthearted, to give readers an opportunity to pick their depth and maybe come back for a second round to dive deeper. I also want this page to bring more people to the JuliaManifolds ecosystem!


Totally independent of all the code stuff here, I really wish I had more manifolds in my earlier math training -- I've had to parse textbooks and online resources independently just to figure out what terms I need to be looking for. What I'm trying to do beyond making the code easy to use and useful, is to make the documentation approachable and give people easy places to connect rather than be overwhelmed on day 1.

@mateuszbaran
Copy link
Contributor Author

I take it from the few changes that you don't have terrible disagreement on the content of the overall page :-) Style is more lighthearted, to give readers an opportunity to pick their depth and maybe come back for a second round to dive deeper. I also want this page to bring more people to the JuliaManifolds ecosystem!

The content is really good. I always struggle with writing more approachable descriptions of manifolds so I appreciate your text 🙂 .

As @kellertuer noted in his comment, there are some differences in notation between this text and JuliaManifolds. Our notation is based on what is most common in manifolds-based optimisation literature, and is also very close to some robotics texts, for example micro Lie theory. Do you want to keep a different notation here?

Totally independent of all the code stuff here, I really wish I had more manifolds in my earlier math training -- I've had to parse textbooks and online resources independently just to figure out what terms I need to be looking for. What I'm trying to do beyond making the code easy to use and useful, is to make the documentation approachable and give people easy places to connect rather than be overwhelmed on day 1.

I think this is very valuable. Manifolds.jl currently has issues with discoverability of certain capabilities. I think it will be much easier if you just ask me or Ronny how to do something, so you would know much faster what you need to be looking for 🙂 . Another benefit is that by knowing what you need we can discover shortcomings of our API and fix them. I definitely want to make Manifolds.jl suitable for robotics applications. When developing Manifolds.jl I take into account the contents of the micro Lie theory paper. For example the ongoing work on manifold automatic differentiation should significantly expand what people can do without working with all this manual chaining of Jacobians but I'm not sure how to communicate this, or what examples would be interesting.

@Affie
Copy link
Member

Affie commented Apr 6, 2022

manifold automatic differentiation

I'm looking forward to this. I decided to wait for AD in manifolds and not do it the jacobian way for the updates that will come soon to the solver.

@mateuszbaran
Copy link
Contributor Author

I'm looking forward to this. I decided to wait for AD in manifolds and not do it the jacobian way for the updates that will come soon to the solver.

Great! We are currently polishing and extending our AD code, as well as preparing some examples of usage. When this is done, we will publish the code. I'm definitely interested in supporting your use cases 🙂 .

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

Successfully merging this pull request may close these issues.

3 participants