[Scipy-svn] r5124 - trunk/doc/releases

[scipy-svn at scipy.org]

Author: jarrod.millman
Date: 2008-11-16 01:28:23 -0600 (Sun, 16 Nov 2008)
New Revision: 5124

Modified:
   trunk/doc/releases/0.7.0-notes.rst
Log:
more rest clean-up


Modified: trunk/doc/releases/0.7.0-notes.rst
===================================================================
--- trunk/doc/releases/0.7.0-notes.rst	2008-11-16 07:04:50 UTC (rev 5123)
+++ trunk/doc/releases/0.7.0-notes.rst	2008-11-16 07:28:23 UTC (rev 5124)
@@ -47,8 +47,8 @@
 
 * numerous bugfixes
 
-SciPy IO
-~~~~~~~~
+Reworking of IO package
+~~~~~~~~~~~~~~~~~~~~~~~
 
 The IO code in both NumPy and SciPy is undergoing a major reworking. NumPy
 will be where basic code for reading and writing NumPy arrays is located,
@@ -59,10 +59,11 @@
 
 * many of the functions in scipy.io have been deprecated
 * the Matlab (TM) file readers/writers have a number of improvements:
+
  * default version 5
 
-Hierarchical Clustering
-=======================
+New Hierarchical Clustering module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This module adds new hierarchical clustering functionality to the
 cluster package. Its interface is similar to the hierarchical
@@ -79,68 +80,49 @@
 matplotlib extension is provided for plotting dendrograms, which
 may be outputted to postscript or any other supported format.
 
-== New Hierarchical Clustering module ==
-This module adds new hierarchical clustering functionality to the
-cluster package. Its interface is similar to the hierarchical
-clustering functions provided in MATLAB(TM)'s Statistics Toolbox to
-facilitate easier migration to the NumPy/SciPy framework. Linkage
-methods implemented include single, complete, average, weighted,
-centroid, median, and ward. Several functions are provided for
-computing statistics on clusters including inconsistency statistics,
-cophenetic distance, and maximum distance of descendants. The fcluster
-and fclusterdata functions take hierarchical tree clusterings
-generated by these algorithms, cuts the tree, and labels the flat
-clusters. The leaders function finds the root of each flat cluster
-given a hierarchical clustering and labellings of its leaves. Finally, a
-matplotlib extension is provided for plotting dendrograms, which
-may be outputted to postscript or any other supported format.
+New Spatial package
+~~~~~~~~~~~~~~~~~~~
 
-http://scipy.org/scipy/scipy/browser/trunk/scipy/cluster/hierarchy.py
+Collection of spatial algorithms and data structures useful for spatial
+statistics and clustering applications. Includes fast compiled code for
+computing exact and approximate nearest neighbors, as well as a pure-python
+kd-tree with the same interface but that supports annotation and a variety
+of other algorithms. The API for both modules may change somewhat as user
+requirements become clearer.
 
-Spatial Package
-===============
-
-The new scipy.spatial package provides routines for distance computation
-and kd-tree manipulation.
-
-== New Spatial package ==
-Collection of spatial algorithms and data structures useful for spatial statistics and clustering applications. Includes fast compiled code for computing exact and approximate nearest neighbors, as well as a pure-python kd-tree with the same interface but that supports annotation and a variety of other algorithms. The API for both modules may change somewhat as user requirements become clearer. Also includes a submodule "distance" containing fast code for many definitions of "distance" between vectors. Distance and dissimilarity functions are provided include Bray-Curtis, Canberra, Chebyshev, City Block, Cosine, Dice, Euclidean, Hamming, Jaccard, Kulsinski, Mahalanobis, Matching, Minkowski, Rogers-Tanimoto, Russell-Rao, Squared Euclidean, Standardized Euclidean, Sokal-Michener, Sokal-Sneath, and Yule. Two functions are provided for computing distances between collections of vectors: pdist and cdist. pdist is similar to the MATLAB(TM) function and computes pairwise distances between a collection of vectors. cdist computes distances between vectors in two sets of vectors. squareform converts between square distance matrices and condensed distance matrices.
-
-
-Distance Module
-----------------
-
-Provides a multitude of common distance functions useful for spatial
-statistics, clustering, and kd-trees. Distance and dissimilarity
-functions provided include Bray-Curtis, Canberra, Chebyshev, City
-Block, Cosine, Dice, Euclidean, Hamming, Jaccard, Kulsinski,
+Also includes a submodule ``distance`` containing fast code for many definitions
+of *distance* between vectors.  These common distance functions are useful for
+for many agorthms including spatial statistics, clustering, and kd-trees.
+Distance and dissimilarity functions provided include Bray-Curtis, Canberra,
+Chebyshev, City Block, Cosine, Dice, Euclidean, Hamming, Jaccard, Kulsinski,
 Mahalanobis, Matching, Minkowski, Rogers-Tanimoto, Russell-Rao,
-Squared Euclidean, Standardized Euclidean, Sokal-Michener,
-Sokal-Sneath, and Yule. Two functions are provided for computing
-distances between collections of vectors: pdist and cdist. pdist
-is similar to the MATLAB(TM) function and computes pairwise distances
-between a collection of vectors. cdist computes distances between
-vectors in two sets of vectors. squareform is useful for converting
-a square distance matrix to a condensed matrix and vice versa.
+Squared Euclidean, Standardized Euclidean, Sokal-Michener, Sokal-Sneath,
+and Yule. Two functions are provided for computing distances between
+collections of vectors: ``pdist`` and ``cdist``. ``pdist`` is similar to the
+MATLAB(TM) function and computes pairwise distances between a collection of
+vectors. ``cdist`` computes distances between vectors in two sets of vectors.
+``squareform`` converts between square distance matrices and condensed
+distance matrices.
 
+Reworked fftpack package
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-fftpack
-~~~~~~~
-
 FFTW2, FFTW3, MKL and DJBFFT wrappers have been removed. Only (NETLIB)
 fftpack remains. By focusing on one backend, we hope to add new
 features -- like float32 support -- more easily.
 
+New Constants package
+~~~~~~~~~~~~~~~~~~~~~
 
-== New Constants package ==
-Collection of physical constants and conversion factors:
-http://scipy.org/scipy/scipy/browser/trunk/scipy/constants/
+Collection of physical constants and conversion factors.
 
+New Radial Basis Function module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-== New Radial Basis Function module ==
 http://scipy.org/scipy/scipy/browser/trunk/scipy/interpolate/rbf.py
 
-== Improved documentation ==
+Major documentation improvements
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 TODO
 
@@ -153,5 +135,5 @@
 Building SciPy
 ~~~~~~~~~~~~~~
 
-Support for !NumScons has been added. numscons is a tentative new
-build system for numpy/scipy, using scons at its core.
+Support for NumScons has been added. NumScons is a tentative new
+build system for NumPy/SciPy, using scons at its core.