Merge pull request #44 from PAIR-code/0_1_1

Import latest code changes (0.1.1)

README.md

@@ -42,6 +42,11 @@ For a broader overview, check out [our paper](https://arxiv.org/abs/2008.05122)
 
 ## Download and Installation
 
+LIT can be installed via pip, or can be built from source. Building from source
+is necessary if you wish to update any of the front-end or core back-end code.
+
+### Install from source
+
 Download the repo and set up a Python environment:
 
 ```sh
@@ -63,6 +68,18 @@ Note: if you see [an error](https://github.com/yarnpkg/yarn/issues/2821)
 running yarn on Ubuntu/Debian, be sure you have the
 [correct version installed](https://yarnpkg.com/en/docs/install#linux-tab).
 
+### pip installation
+
+```sh
+pip install lit-nlp
+```
+
+The pip installation will install all necessary prerequisite packages for use
+of the core LIT package. It also installs the code to run our demo examples.
+It does not install the prerequisites for those demos, so you need to install
+those yourself if you wish to run the demos. See
+[environment.yml](./environment.yml) for the list of all packages needed for
+running the demos.
 
 ## Running LIT
 

lit_nlp/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2020 Google LLC
+#
+# 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.

lit_nlp/api/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2020 Google LLC
+#
+# 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.

lit_nlp/app.py

@@ -17,6 +17,7 @@
 
 import collections
 import functools
+import glob
 import os
 import pickle
 import random
@@ -42,7 +43,6 @@
 from lit_nlp.lib import serialize
 from lit_nlp.lib import utils
 from lit_nlp.lib import wsgi_app
-import glob
 
 
 JsonDict = types.JsonDict

lit_nlp/components/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2020 Google LLC
+#
+# 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.

lit_nlp/components/citrus/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2020 Google LLC
+#
+# 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.

lit_nlp/components/index.py

@@ -30,7 +30,6 @@
 from lit_nlp.lib import utils
 
 
-
 class Indexer(object):
   """Class to build and search annoy indices.