Folktables plural. Stub out basic readme

socialfoundations · Jun 14, 2021 · 5a19f8d · 5a19f8d
1 parent 86128a0
commit 5a19f8d
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,50 @@
 # Folktables
 
+**Folktables** is a TODO: one-paragraph description.
 
-# TODO: Add to PyPI.
-To make the shared code available outside the `pkg/tablebench` directory, you can make the code accessible as a Python package by running the following command in the `pkg` directory:
+
+## Table of Contents
+1. [Basic installation instructions](#basic-installation-instructions)
+2. [Quick start examples](#quick-start-examples)
+3. [Datasets in folktables](#datasets-in-folktables)
+5. [Frequently asked questions](#frequently-asked-questions)
+6. [Citing folkTables](#citing-folktables)
+
+Folktables is still under active development! If you find bugs or have feature
+requests, please file a
+[Github issue](https://github.com/zykls/folktables/issues). 
+We welcome all kinds of issues, especially those related to correctness, documentation, performance, and new features.
+
+
+## Basic installation instructions
+1. (Optionally) create a virtual environment
 ```
-pip install -e .
+python3 -m venv folkenv
+source folkenv/bin/activate
 ```
-This also installs the dependencies for our shared code listed in `setup.py` (e.g., NumPy, Pandas, etc.) if they are not available yet.
-After installing the package, you can simply import the code with
+2. Install via pip
 ```
-import tablebench
+pip install folktables
 ```
+You can also install folktables directly from source.
+```
+git clone https://github.com/zykls/folktables.git
+cd folktables
+pip install -r requirements.txt
+```
+
+
+## Quick start examples
+TODO!
+
+
+## Datasets in folktables
+TODO!
+
+
+## Frequently asked questions
+TODO!
+
+
+## Citing folktables
+TODO!
diff --git a/folktable/__init__.py → folktables/__init__.py b/folktable/__init__.py → folktables/__init__.py
diff --git a/folktable/data_source.py → folktables/data_source.py b/folktable/data_source.py → folktables/data_source.py
diff --git a/folktable/load_pums.py → folktables/load_pums.py b/folktable/load_pums.py → folktables/load_pums.py
diff --git a/folktable/pums.py → folktables/pums.py b/folktable/pums.py → folktables/pums.py
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,3 @@
+-e .
+
+pytest
diff --git a/setup.py b/setup.py
@@ -1,15 +1,15 @@
 from setuptools import setup, find_packages
 
 setup(
-    name="folktable",
+    name="folktables",
+    version="0.0.0",
     author="John Miller, Frances Ding, Ludwig Schmidt, Moritz Hardt",
     author_email="miller_john@berkeley.edu",
     description="New machine learning benchmarks from tabular datasets.",
     packages=find_packages(),
     install_requires=[
-		"numpy",
+        "numpy",
         "pandas",
-		"pytest",
         "sklearn",
     ],
     classifiers=[