Skip to content

Commit b64d03d

Browse files
iftenneyLIT team
iftenney
authored and
LIT team
committed
Website updates: consolidate setup guides and FAQ pages, fix broken links.
Also rename 'experimental' layout to 'three_panel' as more descriptive. PiperOrigin-RevId: 566389066
1 parent 0b04278 commit b64d03d

File tree

16 files changed

+81
-417
lines changed

16 files changed

+81
-417
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ conda install python=3.10
110110
conda install pip
111111
```
112112

113-
Install dependencies:
113+
Once you have the environment, install LIT's dependencies:
114114
```sh
115115
python -m pip install -r requirements.txt
116116
python -m pip install cudnn cupti # optional, for GPU support
@@ -134,7 +134,7 @@ running `yarn` on Ubuntu/Debian, be sure you have the
134134
## Running LIT
135135

136136
Explore a collection of hosted demos on the
137-
[LIT website demos page](https://pair-code.github.io/lit/demos).
137+
[demos page](https://pair-code.github.io/lit/demos).
138138

139139
### Quick-start: classification and regression
140140

‎RELEASE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Major changes include:
3030
capability.
3131
* Updated to Python 3.10.
3232
* Updated to Node 18 and Typescript 5.0.
33+
* Improved documentation pages, now at https://pair-code.github.io/lit/documentation/
3334

3435

3536
This release would not have been possible without the work of our new

‎lit_nlp/api/layout.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,5 +258,5 @@ def to_json(self) -> dtypes.JsonDict:
258258
DEFAULT_LAYOUTS = {
259259
'simple': SIMPLE_LAYOUT,
260260
'default': STANDARD_LAYOUT,
261-
'experimental': THREE_PANEL_LAYOUT,
261+
'three_panel': THREE_PANEL_LAYOUT,
262262
}

‎lit_nlp/client/core/app_statusbar.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export class StatusbarComponent extends MobxLitElement {
5656
});
5757

5858
const bugLink = 'https://github.com/PAIR-code/lit/issues';
59-
const docLink = 'https://github.com/PAIR-code/lit/wiki';
59+
const docLink = 'https://pair-code.github.io/lit/documentation/';
6060
const helpLink = 'mailto:[email protected]';
6161

6262
// clang-format off

‎website/sphinx_src/demos.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ https://pair-code.github.io/lit/tutorials/sentiment
5858

5959
--------------------------------------------------------------------------------
6060

61-
## Regression / Scoring {.demo-section-header}
61+
## Regression / Scoring <!-- DO NOT REMOVE {#regression-scoring .demo-section-header} -->
6262

6363
### Textual Similarity (STS-B) <!-- DO NOT REMOVE {#stsb .demo-header} -->
6464

‎website/sphinx_src/faq.md‎

Lines changed: 47 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,42 @@
44

55
<!-- [TOC] placeholder - DO NOT REMOVE -->
66

7+
Looking for help? Submit bugs, ask questions, suggest content, and request
8+
features on our
9+
[Github issues list](https://github.com/pair-code/lit/issues/).
10+
11+
## Model and Data Types
12+
13+
LIT can handle a variety of models with different input and output types, and
14+
works with any modern ML framework. For more information, see
15+
[Framework & Model Support](components.md#framework-and-model-support).
16+
17+
In addition to text, LIT has good support for different modalities, including
18+
images and tabular data. For examples, see:
19+
20+
* [Image demo](https://github.com/PAIR-code/lit/blob/main/lit_nlp/examples/image_demo.py) -
21+
image classification, using a Mobilenet model.
22+
* [Tabular demo](https://github.com/PAIR-code/lit/blob/main/lit_nlp/examples/penguin_demo.py) -
23+
mult-class classification on tabular (numeric and categorical string) data,
24+
using the
25+
[Palmer Penguins](https://www.tensorflow.org/datasets/catalog/penguins)
26+
dataset.
27+
28+
For more details, see
29+
[the features guide to input and output types](api.md#type-system).
30+
31+
## Languages
32+
33+
All strings in LIT are unicode and most components use model-provided
34+
tokenization if available, so in most cases non-English languages and non-Latin
35+
scripts should work without any modifications. For examples, see:
36+
37+
* [XNLI demo](https://github.com/PAIR-code/lit/blob/main/lit_nlp/examples/xnli_demo.py) -
38+
cross-lingual NLI, with up to 15 languages supported via a multilingual BERT
39+
model.
40+
* [T5 demo](https://github.com/PAIR-code/lit/blob/main/lit_nlp/examples/t5_demo.py) -
41+
includes WMT data for machine translation
42+
743
## Scale
844

945
### Dataset Size
@@ -66,41 +102,19 @@ LIT has the ability to create or edit datapoints in the UI and then save them to
66102
disk. If you do not want the tool to to be able to write edited datapoints to
67103
disk, then pass the `--demo_mode` runtime flag to the LIT server.
68104

69-
### Managing Access
105+
### I have proprietary data. Is LIT secure for my team to use?
70106

71-
The default LIT development server does not implement any explicit access
72-
controls. However, this is just a thin convenience wrapper, and the underlying
73-
WSGI App can be easily exported and used with additional middleware layers or
74-
external serving frameworks. See
75-
[Running LIT in a Docker container](./docker.md) for an example of this usage.
76-
77-
## Languages
78-
79-
All strings in LIT are unicode and most components use model-provided
80-
tokenization if available, so in most cases non-English languages and non-Latin
81-
scripts should work without any modifications. For examples, see:
82-
83-
* [XNLI demo](https://github.com/PAIR-code/lit/blob/main/lit_nlp/examples/xnli_demo.py) -
84-
cross-lingual NLI, with up to 15 languages supported via a multilingual BERT
85-
model.
86-
* [T5 demo](https://github.com/PAIR-code/lit/blob/main/lit_nlp/examples/t5_demo.py) -
87-
includes WMT data for machine translation
107+
We don't store, collect or share datasets, models or any other information
108+
loaded into LIT. When you run a LIT server, anyone with access to the web
109+
address of the server will be able to see data from the loaded datasets and
110+
interact with the loaded models. If you need to restrict access to a LIT
111+
server, then make sure to configure the hosting of your LIT server to do so.
88112

89-
## Data Types
90-
91-
In addition to text, LIT has good support for different input and output
92-
modalities, including images and tabular data. For examples, see:
93-
94-
* [Image demo](https://github.com/PAIR-code/lit/blob/main/lit_nlp/examples/image_demo.py) -
95-
image classification, using a Mobilenet model.
96-
* [Tabular demo](https://github.com/PAIR-code/lit/blob/main/lit_nlp/examples/penguin_demo.py) -
97-
mult-class classification on tabular (numeric and categorical string) data,
98-
using the
99-
[Palmer Penguins](https://www.tensorflow.org/datasets/catalog/penguins)
100-
dataset.
101-
102-
For more details, see
103-
[the features guide to input and output types](api.md#type-system).
113+
The default LIT development server does not implement any explicit access
114+
controls. However, this server is just a thin convenience wrapper, and the
115+
underlying WSGI App can be easily exported and used with additional middleware
116+
layers or external serving frameworks. See
117+
[Running LIT in a Docker container](./docker.md) for an example.
104118

105119
## Workflow and Integrations
106120

‎website/sphinx_src/getting_started.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44

55
<!-- [TOC] placeholder - DO NOT REMOVE -->
66

7+
## Installation
8+
9+
Using pip:
10+
11+
```sh
12+
pip install lit-nlp
13+
```
14+
15+
For more details or to install from source, see
16+
[GitHub](https://github.com/pair-code/lit#download-and-installation).
17+
718
## Hosted demos
819

920
If you want to jump in and start playing with the LIT UI, check out

‎website/sphinx_src/index.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44

55
<!-- [TOC] placeholder - DO NOT REMOVE -->
66

7-
Welcome to 🔥LIT, the Learning Interpretability Tool (formerly the Language
8-
Interpretability Tool)!
7+
Welcome to 🔥LIT, the Learning Interpretability Tool!
98

10-
If you want to jump in and start playing with the LIT UI, check out
11-
https://pair-code.github.io/lit/demos/ for links to our hosted demos.
9+
If you want to jump in and start playing with the LIT UI, check out the hosted demos at https://pair-code.github.io/lit/demos/.
1210

1311
```{toctree}
1412
:maxdepth: 2

‎website/src/_includes/partials/header.liquid‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
<div class="mdl-layout-spacer"></div>
1313
<!-- Navigation. We hide it in small screens. -->
1414
<nav class="mdl-navigation mdl-layout--large-screen-only">
15-
<a class="mdl-navigation__link" href="{% root %}/setup/">SETUP GUIDE</a>
15+
<a class="mdl-navigation__link" href="{% root %}/documentation/getting_started.html">GETTING STARTED</a>
1616
<a class="mdl-navigation__link" href="{% root %}/tutorials/">TUTORIALS</a>
1717
<a class="mdl-navigation__link" href="{% root %}/demos/">DEMOS</a>
1818
<a class="mdl-navigation__link" href="{% root %}/documentation/">DOCUMENTATION</a>
19-
<a class="mdl-navigation__link" href="{% root %}/faqs/">FAQs</a>
19+
<a class="mdl-navigation__link" href="{% root %}/documentation/faq.html">FAQs</a>
2020
<a class="mdl-navigation__link" href="https://groups.google.com/g/lit-annoucements" target="-_blank">STAY UP TO DATE<img class="header-arrow" src="{% root %}/assets/images/arrow-link-out.png"/></a>
2121
<a class="mdl-navigation__link" href="https://github.com/pair-code/lit" target="-_blank">GITHUB<img class="header-arrow" src="{% root %}/assets/images/arrow-link-out.png"/></a>
2222
</nav>
@@ -25,11 +25,11 @@
2525
<div class="mdl-layout__drawer">
2626
<span class="mdl-layout__title"><a href="{% root %}/">Learning Interpretability Tool</a></span>
2727
<nav class="mdl-navigation">
28-
<a class="mdl-navigation__link" href="{% root %}/setup/">SETUP GUIDE</a>
28+
<a class="mdl-navigation__link" href="{% root %}/documentation/getting_started.html">GETTING STARTED</a>
2929
<a class="mdl-navigation__link" href="{% root %}/tutorials/">TUTORIALS</a>
3030
<a class="mdl-navigation__link" href="{% root %}/demos/">DEMOS</a>
3131
<a class="mdl-navigation__link" href="{% root %}/documentation/">DOCUMENTATION</a>
32-
<a class="mdl-navigation__link" href="{% root %}/faqs/">FAQs</a>
32+
<a class="mdl-navigation__link" href="{% root %}/documentation/faq.html">FAQs</a>
3333
<a class="mdl-navigation__link" href="https://groups.google.com/g/lit-annoucements" target="_blank">STAY UP TO DATE<img class="header-arrow" src="{% root %}/assets/images/arrow-link-out.png"/></a>
3434
<a class="mdl-navigation__link" href="https://github.com/pair-code/lit" target="-_blank">GITHUB<img class="header-arrow" src="{% root %}/assets/images/arrow-link-out.png"/></a>
3535
</nav>

‎website/src/faqs.md‎

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

0 commit comments

Comments
 (0)