From 996de773ed118ddcdb7b6ee2bfeaa30fb26dc319 Mon Sep 17 00:00:00 2001 From: Doug Branton Date: Mon, 10 Jun 2024 15:14:16 -0700 Subject: [PATCH 1/3] avoid NestedFrame API in generation module --- src/nested_pandas/datasets/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/nested_pandas/datasets/__init__.py b/src/nested_pandas/datasets/__init__.py index 4b8e827..d90b287 100644 --- a/src/nested_pandas/datasets/__init__.py +++ b/src/nested_pandas/datasets/__init__.py @@ -1 +1 @@ -from .generation import * # noqa +from .generation import generate_data, generate_parquet_file # noqa From 0bea3d2444eb349e141dffd3cfa009dd404d23b3 Mon Sep 17 00:00:00 2001 From: Doug Branton Date: Mon, 10 Jun 2024 15:28:54 -0700 Subject: [PATCH 2/3] avoid import api --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 8b2194f..61ed9b2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,6 +54,9 @@ autoapi_ignore = ["*/__main__.py", "*/_version.py"] autoapi_add_toc_tree_entry = False autoapi_member_order = "bysource" +autoapi_options = ['members', 'undoc-members', 'private-members', + 'show-inheritance', 'show-module-summary', + 'special-members',] html_theme = "sphinx_book_theme" From 1f958fbcb06dcadeb0d93331a755fd0f4b7e6a37 Mon Sep 17 00:00:00 2001 From: Doug Branton Date: Mon, 10 Jun 2024 15:34:45 -0700 Subject: [PATCH 3/3] remove private docs; remove example benchmarks --- docs/conf.py | 10 +++++++--- src/nested_pandas/datasets/__init__.py | 2 +- src/nested_pandas/example_benchmarks.py | 14 -------------- 3 files changed, 8 insertions(+), 18 deletions(-) delete mode 100644 src/nested_pandas/example_benchmarks.py diff --git a/docs/conf.py b/docs/conf.py index 61ed9b2..422bd67 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,9 +54,13 @@ autoapi_ignore = ["*/__main__.py", "*/_version.py"] autoapi_add_toc_tree_entry = False autoapi_member_order = "bysource" -autoapi_options = ['members', 'undoc-members', 'private-members', - 'show-inheritance', 'show-module-summary', - 'special-members',] +autoapi_options = [ + "members", + "undoc-members", + "show-inheritance", + "show-module-summary", + "special-members", +] html_theme = "sphinx_book_theme" diff --git a/src/nested_pandas/datasets/__init__.py b/src/nested_pandas/datasets/__init__.py index d90b287..4b8e827 100644 --- a/src/nested_pandas/datasets/__init__.py +++ b/src/nested_pandas/datasets/__init__.py @@ -1 +1 @@ -from .generation import generate_data, generate_parquet_file # noqa +from .generation import * # noqa diff --git a/src/nested_pandas/example_benchmarks.py b/src/nested_pandas/example_benchmarks.py deleted file mode 100644 index 5a77b06..0000000 --- a/src/nested_pandas/example_benchmarks.py +++ /dev/null @@ -1,14 +0,0 @@ -"""An example module containing simplistic methods under benchmarking.""" - -import random -import time - - -def runtime_computation(): - """Runtime computation consuming between 0 and 5 seconds.""" - time.sleep(random.uniform(0, 5)) - - -def memory_computation(): - """Memory computation for a random list up to 512 samples.""" - return [0] * random.randint(0, 512)