Skip to content

Commit

Permalink
continued work on terms page
Browse files Browse the repository at this point in the history
  • Loading branch information
@joaquinvanschoren
joaquinvanschoren committed Nov 3, 2023
1 parent b1b8fbb commit 4625408
Show file tree
Hide file tree
Showing 5 changed files with 162 additions and 52 deletions.
53 changes: 37 additions & 16 deletions app/public/locales/en/common.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,6 @@
"donation": "Make a donation",
"sponsor": "Become an official Sponsor"
},
"contribute_intro": {
"title": "Contributing",
"text": "The people who contribute to OpenML do so for the love of\nmachine learning and because they want to help build a more\ninclusive and frictionless ecosystem of data, tools and clear\nresults. You can contribute in different ways:",
"items": [
"Help us improve the OpenML platform and interfaces.",
"Make a donation to support our community and keep OpenML free.",
"Share new interesting datasets, models, and experiments."
]
},
"help_dev": {
"title": "Are you a developer?",
"text": "We want to make OpenML ridiculously easy to use and empowering.\nContribute your skill and expertise to make OpenML better for yourself and others, either online (on GitHub) or during one of our coding sprints.",
Expand All @@ -93,7 +84,7 @@
]
},
"help_donate": {
"title": "Are you one of us?",
"title": "All help is welcome",
"text": "OpenML depends on all of us. You can help keep OpenML free\nand support our community by making a donation (no pressure).\nYou can also join us at an OpenML event, or organize one\nyourself! Or maybe you have another great idea? Please don't hesitate to reach out!",
"chips": [
"Make a donation",
Expand Down Expand Up @@ -304,15 +295,45 @@
"helmet": "Terms & Citation",
"title": "Terms & Citation",
"header": {
"licence": "Licenses"
"licence": "Licenses",
"citation": "Citing OpenML",
"citation_sub": "If you have used OpenML in a scientific publication, we would appreciate citations to the most relevant papers below."
},
"contact": {
"licences": {
"title": "Open Machine Learning, Open licenses.",
"text": "We believe that machine learning should be as open and accessible as possible. The OpenML team and contributers have invested countless hours of time and resources to make this dream come true, so please give credit where credit is due.",
"text": "We believe that machine learning should be as open and accessible as possible. The OpenML team and contributers have invested countless hours of time and resources to make this dream come true, so please give credit where credit is due. We have chosen the following licenses to make sure that OpenML can be used by everyone, and that everyone can benefit from it. Click each item for more details.",
"items": [
"You are free to use OpenML and all empirical data and metadata under the **CC-BY license**. To cite us, please use the citations below.",
"The code of the OpenML platform and libraries is **BSD licensed**.",
"Individual datasets and algorithms may come with their own citation requests. Please honor such requests. OpenML will show them when they are known."
"You are free to use OpenML and all data under the **CC-BY license**. This means that you can use and reuse it freely if you also give appropriate credit. To cite us, please use the appropriate citations below.",
"Individual datasets, models, and benchmarks may come with their own licences and citation requests. OpenML will show them when they are known.",
"OpenML is entirely open source, including the platform code itself and all libraries. All code is **BSD licensed**, one of the most permissive licences available."
]
},
"cite_openml": {
"title": "OpenML Platform",
"text": "Joaquin Vanschoren, Jan N. van Rijn, Bernd Bischl, Luis Torgo. **OpenML: networked science in machine learning.** _SIGKDD Explorations 15(2), pp 49-60, 2013_",
"chips": [
"Paper"
]
},
"cite_python": {
"title": "OpenML Python API",
"text": "Matthias Feurer, Jan N. van Rijn, Arlind Kadra, Pieter Gijsbers, Neeratyoy Mallik, Sahithya Ravi, Andreas Mueller, Joaquin Vanschoren, Frank Hutter. **OpenML-Python: an extensible Python API for OpenML.** _JMLR 22(1), Art. 100, pp 4573-4577, 2021_",
"chips": [
"Paper"
]
},
"cite_r": {
"title": "OpenML R API",
"text": "Giuseppe Casalicchio, Jakob Bossek, Michel Lang, Dominik Kirchhoff, Pascal Kerschke, Benjamin Hofner, Heidi Seibold, Joaquin Vanschoren, Bernd Bischl. **OpenML: An R package to connect to the machine learning platform OpenML.** _Computational Statistics 32(3), pp 1-15, 2017_",
"chips": [
"Paper"
]
},
"cite_benchmark": {
"title": "OpenML Benchmarking suites",
"text": "Bernd Bischl, Giuseppe Casalicchio, Matthias Feurer, Pieter Gijsbers, Frank Hutter, Michel Lang, Rafael Gomes Mantovani, Jan N. van Rijn, Joaquin Vanschoren. **OpenML Benchmarking Suites.** _Advances in Neural Information Processing Systems (NeurIPS 2021), 2021_",
"chips": [
"Paper"
]
}
}
Expand Down
4 changes: 4 additions & 0 deletions app/src/components/Card.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ const ButtonImage = styled.img`
}
`;

const copyText = (text) => {
navigator.clipboard.writeText(text);
};

const InfoCard = ({ info }) => {
const theme = useTheme();
const { t } = useTranslation();
Expand Down
22 changes: 15 additions & 7 deletions app/src/components/Header.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,32 @@ import Link from "next/link";
import { Typography } from "@mui/material";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";

const HeroTitle = styled(Typography)`
const HeroBox = styled(Typography)`
text-align: center;
line-height: 150%;
padding-top: 2em;
padding-bottom: 1em;
scroll-margin-top: 2.5em;
`;

const HeroSubTitle = styled(Typography)`
const HeroTitle = styled(Typography)`
text-align: center;
line-height: 150%;
font-size: 1.1rem;
padding-top: 0.5vw;
`;

const Header = ({ id, title, icon, color }) => {
const HeroSubTitle = styled(Typography)`
text-align: center;
line-height: 150%;
font-size: 0.9rem;
padding-top: 0.5vw;
`;

const Header = ({ id, title, subtitle, icon, color }) => {
return (
<HeroTitle variant="h3" align="center" id={id}>
<HeroSubTitle>
<HeroBox variant="h3" align="center" id={id}>
<HeroTitle>
<Link href={`#${id}`}>
<FontAwesomeIcon
icon={icon}
Expand All @@ -33,8 +40,9 @@ const Header = ({ id, title, icon, color }) => {
</Link>
<br />
{title}
</HeroSubTitle>
</HeroTitle>
</HeroTitle>
<HeroSubTitle>{subtitle}</HeroSubTitle>
</HeroBox>
);
};

Expand Down
25 changes: 2 additions & 23 deletions app/src/pages/contribute.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,27 +133,6 @@ const Hero = () => {
);
};

const contribute_intro = {
id: "contribute.contribute_intro",
items: [
{
icon: faHandHoldingHeart,
link: "contribute#help",
color: red[500],
},
{
icon: faHandHoldingDollar,
link: "contribute#sponsor",
color: green[500],
},
{
icon: faHandHoldingMedical,
link: "contribute#help",
color: blue[500],
},
],
};

const help_dev = {
id: "contribute.help_dev",
icon: faUsersCog,
Expand Down Expand Up @@ -422,7 +401,7 @@ function Contribute() {
/>
</Grid>
{[help_dev, help_science, help_exec, help_donate].map((card) => (
<Grid item display="flex" xs={12} md={6} xl={3} key={card.id}>
<Grid item display="flex" xs={12} sm={6} key={card.id}>
<InfoCard info={card} />
</Grid>
))}
Expand All @@ -435,7 +414,7 @@ function Contribute() {
/>
</Grid>
{[code, website, docs, datasets, ambassador].map((card) => (
<Grid item display="flex" xs={12} md={6} lg={4} key={card.id}>
<Grid item display="flex" xs={12} sm={6} lg={4} key={card.id}>
<InfoCard info={card} />
</Grid>
))}
Expand Down
110 changes: 104 additions & 6 deletions app/src/pages/terms.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,26 @@ import Wrapper from "../components/Wrapper";
import { useTranslation } from "next-i18next";
import { serverSideTranslations } from "next-i18next/serverSideTranslations";
import {
faBoltLightning,
faBookOpen,
faChartColumn,
faComments,
faCopy,
faHeart,
faLayerGroup,
faPhoneAlt,
faR,
faScaleBalanced,
faUniversalAccess,
} from "@fortawesome/free-solid-svg-icons";
import {
faCreativeCommons,
faCreativeCommonsBy,
faOsi,
faPython,
faRProject,
} from "@fortawesome/free-brands-svg-icons";
import { blue, green, purple } from "@mui/material/colors";
import { blue, green, orange, purple, red } from "@mui/material/colors";
import Header from "../components/Header";
import InfoCard from "../components/Card";
export async function getStaticProps({ locale }) {
Expand All @@ -40,24 +49,99 @@ const Title = styled(Typography)`
`;

const contact = {
id: "terms.contact",
id: "terms.licences",
icon: faUniversalAccess,
iconColor: blue[400],
items: [
{
link: "http://creativecommons.org/licenses/by/4.0/",
icon: faCreativeCommonsBy,
color: green[400],
target: "_blank",
},
{
link: "https://creativecommons.org/publicdomain/zero/1.0/",
icon: faCreativeCommons,
color: purple[400],
target: "_blank",
},
{
link: "https://opensource.org/licenses/BSD-3-Clause",
icon: faOsi,
color: blue[400],
target: "_blank",
},
],
};

const bibtex_openml = `@article{OpenML2013,
author = {Joaquin Vanschoren and Jan N. van Rijn and Bernd Bischl and Luis Torgo},
title = {OpenML: networked science in machine learning},
journal = {SIGKDD Explorations},
volume = {15},
number = {2},
year = {2013},
pages = {49-60},
url = {http://doi.acm.org/10.1145/2641190.264119},
doi = {10.1145/2641190.2641198},
publisher = {ACM}
}`;

const cite_openml = {
id: "terms.cite_openml",
icon: faLayerGroup,
iconColor: blue[500],
chips: [
{
link: "https://www.kdd.org/exploration_files/15-2-2013-12.pdf#page=51",
icon: faBookOpen,
target: "_blank",
},
],
bibtex: [
{
link: "https://creativecommons.org/publicdomain/zero/1.0/",
icon: faCreativeCommons,
color: purple[400],
bibtex: { bibtex_openml },
icon: faCopy,
target: "_blank",
},
],
};

const cite_python = {
id: "terms.cite_python",
icon: faPython,
iconColor: blue[500],
chips: [
{
link: "https://jmlr2020.csail.mit.edu/papers/volume22/19-920/19-920.pdf",
icon: faBookOpen,
target: "_blank",
},
],
};

const cite_r = {
id: "terms.cite_r",
icon: faRProject,
iconColor: blue[500],
chips: [
{
link: "https://arxiv.org/abs/1701.01293",
icon: faBookOpen,
target: "_blank",
},
],
};

const cite_benchmark = {
id: "terms.cite_benchmark",
icon: faChartColumn,
iconColor: blue[400],
chips: [
{
link: "https://datasets-benchmarks-proceedings.neurips.cc/paper_files/paper/2021/hash/c7e1249ffc03eb9ded908c236bd1996d-Abstract-round2.html",
icon: faBookOpen,
target: "_blank",
},
],
};
Expand All @@ -80,13 +164,27 @@ function Terms() {
</Grid>
<Grid item xs={12}>
<Header
id="contact"
id="licence"
title={t("terms.header.licence")}
icon={faScaleBalanced}
color={green[500]}
/>
<InfoCard info={contact} />
</Grid>
<Grid item xs={12}>
<Header
id="intro"
title={t("terms.header.citation")}
subtitle={t("terms.header.citation_sub")}
icon={faHeart}
color={red[400]}
/>
</Grid>
{[cite_openml, cite_python, cite_r, cite_benchmark].map((card) => (
<Grid item display="flex" xs={12} sm={6} key={card.id}>
<InfoCard info={card} />
</Grid>
))}
</Grid>
</Wrapper>
);
Expand Down

0 comments on commit 4625408

Please sign in to comment.