diff --git a/coreax/__init__.py b/coreax/__init__.py index 143f486c0..85125554a 100644 --- a/coreax/__init__.py +++ b/coreax/__init__.py @@ -1 +1,26 @@ +# © Crown Copyright GCHQ +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +r""" +Coreax library for generation of compressed representations of datasets. + +The coreax library contains code to address the following generic problem. Given an +:math:`n \times d` dataset, generate a :math:`m \times d` dataset, with :math:`m << n` +such that the generated dataset contains as much of the information from the original +dataset as possible. The generated dataset is often called a coreset. +""" + # __init__.py + +__version__ = "0.1.0" diff --git a/examples/__init__.py b/examples/__init__.py index e69de29bb..2666a72fe 100644 --- a/examples/__init__.py +++ b/examples/__init__.py @@ -0,0 +1,20 @@ +# © Crown Copyright GCHQ +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +""" +Example use cases of the coreax library. + +Examples showcase coreset generation on different datasets, as well as using different +coreset generation algorithms to illustrate the capabilities of the library. +""" diff --git a/tests/__init__.py b/tests/__init__.py index e69de29bb..82b3b100c 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1,13 @@ +# © Crown Copyright GCHQ +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/tests/integration/__init__.py b/tests/integration/__init__.py index e69de29bb..39692d338 100644 --- a/tests/integration/__init__.py +++ b/tests/integration/__init__.py @@ -0,0 +1,19 @@ +# © Crown Copyright GCHQ +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +""" +Integration tests to verify functionality of the coreax library. + +Tests for end-to-end runs in typical applications of the coreax library. +""" diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py index e69de29bb..539cf6349 100644 --- a/tests/unit/__init__.py +++ b/tests/unit/__init__.py @@ -0,0 +1,20 @@ +# © Crown Copyright GCHQ +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +""" +Unit tests to verify functionality of the coreax library. + +Tests for specific functions, methods and classes in the coreax library, to ensure +functionality is as expected. +"""