docs: Revise index.rst and users.rst Tighten prose and standardize punctuation and list formatting in index.rst and users.rst. Change-Id: I63a668834d12c11ac42261d13b5ae005af29f331
diff --git a/docs/source/index.rst b/docs/source/index.rst index d53f4fb..a242d05 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst
@@ -4,12 +4,12 @@ Ceres Solver ============ -Ceres Solver [#f1]_ is an open source C++ library for modeling and +Ceres Solver [#f1]_ is an open-source C++ library for modeling and solving large, complicated optimization problems. It can be used to solve `Non-linear Least Squares`_ problems with bounds constraints and -general unconstrained optimization problems. It is a mature, feature -rich, and performant library that has been used in production at -Google since 2010. For more, see :doc:`features`. +general unconstrained optimization problems. It is a mature, +feature-rich, and high-performance library that has been used in +production at Google since 2010. See :doc:`features` for an overview. `ceres-solver@googlegroups.com <https://groups.google.com/forum/?fromgroups#!forum/ceres-solver>`_ is @@ -61,14 +61,14 @@ .. rubric:: Footnotes .. [#f1] While there is some debate as to who invented the method of - Least Squares [Stigler]_, there is no questioning the fact - that it was `Carl Friedrich Gauss + least squares [Stigler]_, there is no debate that `Carl + Friedrich Gauss <https://mathshistory.st-andrews.ac.uk/Biographies/Gauss/>`_ - who brought it to the attention of the world. Using just 22 + brought it to the attention of the world. Using just 22 observations of the newly discovered asteroid `Ceres <https://en.wikipedia.org/wiki/Ceres_(dwarf_planet)>`_, Gauss used the method of least squares to correctly predict when - and where the asteroid will emerge from behind the Sun + and where the asteroid would emerge from behind the Sun [TenenbaumDirector]_. We named our solver after Ceres to celebrate this seminal event in the history of astronomy, - statistics and optimization. + statistics, and optimization.
diff --git a/docs/source/users.rst b/docs/source/users.rst index 0e18a44..0e6b0c1 100644 --- a/docs/source/users.rst +++ b/docs/source/users.rst
@@ -6,7 +6,7 @@ * At `Google <https://www.google.com>`_, Ceres is used to: - * Estimate the pose of `Street View`_ cars, aircrafts, and satellites. + * Estimate the pose of `Street View`_ cars, aircraft, and satellites. * Build 3D models for `PhotoTours`_. * Estimate satellite image sensor characteristics. * Stitch `panoramas`_ on Android and iOS. @@ -18,42 +18,41 @@ `calibrating robot-camera systems`_. * `Blender <https://www.blender.org>`_ uses Ceres for `planar tracking`_ and `bundle adjustment`_. -* `OpenMVG <https://github.com/openMVG/openMVG>`_ an open source - multi-view geometry library uses Ceres for `bundle adjustment`_. +* `OpenMVG <https://github.com/openMVG/openMVG>`_, an open-source + multi-view geometry library, uses Ceres for `bundle adjustment`_. * `Microsoft Research <https://www.microsoft.com/en-us/research/>`_ uses - Ceres for nonlinear optimization of objectives involving subdivision + Ceres for non-linear optimization of objectives involving subdivision surfaces under `skinned control meshes`_. -* `Matterport <https://matterport.com/>`_, uses Ceres for global +* `Matterport <https://matterport.com/>`_ uses Ceres for global alignment of 3D point clouds and for pose graph optimization. * The `Autonomous Systems Lab <https://asl.ethz.ch/>`_ at ETH - Zurich uses Ceres for + Zurich uses Ceres for: - * Camera and Camera/IMU Calibration. - * Large scale optimization of visual, inertial, gps and - wheel-odometry data for long term autonomy. + * Camera and camera-IMU calibration. + * Large-scale optimization of visual, inertial, GPS, and + wheel-odometry data for long-term autonomy. * `OpenPTrack <https://github.com/OpenPTrack/open_ptrack>`_ uses Ceres for camera calibration. -* The `Intelligent Autonomous System Lab <https://robotics.dei.unipd.it/>`_ - at University of Padova, Italy, uses Ceres for +* The `Intelligent Autonomous Systems Lab <https://robotics.dei.unipd.it/>`_ + at the University of Padova, Italy, uses Ceres for: - * Camera/depth sensors network calibration. + * Camera and depth-sensor network calibration. * Depth sensor distortion map estimation. -* `Theia <https://github.com/sweeneychris/TheiaSfM>`_ is an open source +* `Theia <https://github.com/sweeneychris/TheiaSfM>`_ is an open-source Structure from Motion library that uses Ceres for `bundle adjustment`_ and camera pose estimation. * The `Applied Research Laboratory <https://www.arl.psu.edu/>`_ at - Pennsylvania State University uses in their synthetic aperture Sonar - beamforming engine, called ASASIN , for estimating platform - kinematics. + Pennsylvania State University uses Ceres in its synthetic aperture + sonar beamforming engine, ASASIN, to estimate platform kinematics. -* `Colmap <https://github.com/colmap/colmap>`_ is an open source - structure from motion library that makes heavy use of Ceres for +* `COLMAP <https://github.com/colmap/colmap>`_ is an open-source + Structure from Motion library that makes heavy use of Ceres for bundle adjustment with support for many camera models and for other - non-linear least-squares problems (relative, absolute pose - refinement, etc.). + non-linear least squares problems (such as relative and absolute pose + refinement).