Skip to content

Commit 0fa0b53

Browse files
authored
DOC Moves under review to top level toc (#40)
1 parent 8e63973 commit 0fa0b53

File tree

4 files changed

+18
-29
lines changed

4 files changed

+18
-29
lines changed

index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
:maxdepth: 1
1010
:caption: Under review
1111

12-
under_review
12+
slep007/proposal
13+
slep012/proposal
14+
slep013/proposal
1315

1416
.. toctree::
1517
:maxdepth: 1

slep007/proposal.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _slep_007:
22

3-
===========================================
4-
Feature names, their generation and the API
5-
===========================================
3+
====================================================
4+
SLEP007: Feature names, their generation and the API
5+
====================================================
66

77
:Author: Adrin Jalali
88
:Status: Under Review

slep012/proposal.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
.. _slep_012:
22

3-
==========
4-
InputArray
5-
==========
3+
=======================
4+
SLEP012: ``InputArray``
5+
=======================
66

77
:Author: Adrin jalali
88
:Status: Draft
99
:Type: Standards Track
1010
:Created: 2019-12-20
1111

1212
Motivation
13-
**********
13+
##########
1414

1515
This proposal results in a solution to propagating feature names through
1616
transformers, pipelines, and the column transformer. Ideally, we would have::
@@ -39,7 +39,7 @@ transformer, would not break. This SLEP focuses on *feature names* as the only
3939
meta-data attached to the data. Support for other meta-data can be added later.
4040

4141
Backward/NumPy/Pandas Compatibility
42-
***********************************
42+
###################################
4343

4444
Since currently transformers return a ``numpy`` or a ``scipy`` array, backward
4545
compatibility in this context means the operations which are valid on those
@@ -59,13 +59,13 @@ which ``pandas`` does not provide a clean API at the moment. Alternatively,
5959
relevant meta-data attached.
6060

6161
Feature Names
62-
*************
62+
#############
6363

6464
Feature names are an object ``ndarray`` of strings aligned with the columns.
6565
They can be ``None``.
6666

6767
Operations
68-
**********
68+
##########
6969

7070
Estimators understand the ``InputArray`` and extract the feature names from the
7171
given data before applying the operations and transformations on the data.
@@ -75,20 +75,20 @@ The way feature names are generated is discussed in *SLEP007 - The Style of The
7575
Feature Names*.
7676

7777
Sparse Arrays
78-
*************
78+
#############
7979

8080
Ideally sparse arrays follow the same pattern, but since ``scipy.sparse`` does
8181
not provide the kinda of API provided by ``numpy``, we may need to find
8282
compromises.
8383

8484
Factory Methods
85-
***************
85+
###############
8686

8787
There will be factory methods creating an ``InputArray`` given a
8888
``pandas.DataFrame`` or an ``xarray.DataArray`` or simply an ``np.ndarray`` or
8989
an ``sp.SparseMatrix`` and a given set of feature names.
9090

91-
An ``InputArray`` can also be converted to a `pandas.DataFrame`` using a
91+
An ``InputArray`` can also be converted to a ``pandas.DataFrame`` using a
9292
``todataframe()`` method.
9393

9494
``X`` being an ``InputArray``::
@@ -103,7 +103,7 @@ feature names, one can make the right ``InputArray`` using::
103103
>>> make_inputarray(X, feature_names)
104104

105105
Alternative Solutions
106-
*********************
106+
#####################
107107

108108
Since we expect the feature names to be attached to the data given to an
109109
estimator, there are a few potential approaches we can take:
@@ -114,7 +114,7 @@ estimator, there are a few potential approaches we can take:
114114
is not a feasible solution since ``pandas`` plans to move to a per column
115115
representation, which means ``pd.DataFrame(np.asarray(df))`` has two
116116
guaranteed memory copies.
117-
- ``XArray``: we could accept a `pandas.DataFrame``, and use
117+
- ``XArray``: we could accept a ``pandas.DataFrame``, and use
118118
``xarray.DataArray`` as the output of transformers, including feature names.
119119
However, ``xarray`` has a hard dependency on ``pandas``, and uses
120120
``pandas.Index`` to handle row labels and aligns rows when an operation

under_review.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)