Skip to content

Commit

Permalink
Feature / Documentation update for 07 (#473)
Browse files Browse the repository at this point in the history
* Fix license headers on recently added files

* Fix one link in the main README file

* Update wording for main page of the docs

* Update README top section with the same wording as the docs

* Update development status in the main README.

* Fix display of page contents for classes in API docs

* Add maintainer info back into top sections in README and main docs page

* Update logo for TRAC MMP
  • Loading branch information
martin-traverse authored Nov 12, 2024
1 parent e58b5cd commit 106158c
Show file tree
Hide file tree
Showing 12 changed files with 55 additions and 47 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# ![TRAC Data & Analytics Platform](doc/_images/tracdap_horizontal_400.png)
# ![TRAC: The modern model platform](doc/_images/tracmmp_horizontal_400.png)

*The modern model platform for complex, critical models and calculations.*

[![FINOS - Incubating](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)

TRAC is a universal model orchestration solution which is designed for the most complex, critical
and highly-governed use cases. It combines your existing data and compute infrastructure,
TRAC is a universal model orchestration solution for managing the most complex, critical
and highly governed workflows. It combines your existing data and compute infrastructure,
model development environments and the repository of versioned code, to create a single ecosystem
in which to build and deploy models, orchestrate complex workflows and run analytics.

TRAC is designed to break the trade-off that has traditionally been required, between flexible
(but uncontrolled) analytics solutions and highly controlled (but inflexible) production model
platforms. It offers best of both worlds, power, control and analytical flexibility.

The core platform services - i.e. TRAC Data & Analytics Platform (or TRAC D.A.P.) - are maintained by
[finTRAC Limited](https://www.fintrac.co.uk) in association with the [FINOS Foundation](https://www.finos.org)
under the [Apache Software License version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
TRAC D.A.P. is the open-source data & analytics toolkit which provides the core capabilities of TRAC.
It is maintained by [finTRAC Limited](https://fintrac.co.uk/)
in association with [FINOS](https://www.finos.org/)
and is available to download and use for free under the
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0>).

## Documentation and Packages

Expand All @@ -29,7 +31,7 @@ The following packages are available:
| [Web API package](https://www.npmjs.com/package/@finos/tracdap-web-api) | Build client apps in JavaScript or TypeScript using the TRAC platform APIs |
| [Platform releases](https://github.com/finos/tracdap/releases) | Packages for the platform services and a standalone sandbox are published with each release on GitHub |

Commercially supported deployments of TRAC are separately available from `finTRAC Limited <https://www.fintrac.co.uk>`_.
Commercially supported deployments of TRAC are separately available from [finTRAC Limited](https://www.fintrac.co.uk).

## Development Status

Expand All @@ -45,16 +47,15 @@ https://github.com/finos/tracdap/actions/workflows/packaging.yml)
https://tracdap.finos.org/en/stable/?badge=stable)


The current release series (0.4.x) is intended for model development and prototyping.
It provides an end-to-end workflow to build and run individual models in a local
environment. It also provides the platform APIs needed to build client applications
such as web tools or system client system integrations.
The current release series (0.7) contains the core capabilities needed to build and run models,
both for local development and in a hosted environment. It also contains the platform services
and APIs needed to build client applications and system-to-system integrations.

The TRAC metadata structures and API calls are mostly complete. Metadata compatibility
is ensured within a release series starting from version 0.4.0 - the 0.4.x series
will be compatible with 0.4.0 but changes may be introduced in 0.5.0. The metadata
model will continue to stabilise before eventually being frozen for version 1.0.0,
after which it may be added to but no fields will be removed or changed.
Metadata compatibility is guaranteed within each release series (e.g. 0.7.x). Minor changes may
occur between release series, mostly for internal structures and removal of deprecated APIs.
The metadata model will be frozen at version 1.0 after which it may be added to but no fields
will be removed or change. Configuration formats are subject to change between versions and
extension (plugin) APIs should be considered internal for the time being.

For more information see the
[development roadmap](https://github.com/finos/tracdap/wiki/Development-Roadmap).
Expand Down
Binary file removed doc/_images/tracdap_horizontal.png
Binary file not shown.
Binary file removed doc/_images/tracdap_horizontal_400.png
Binary file not shown.
Binary file added doc/_images/tracmmp_horizontal_400.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 8 additions & 5 deletions doc/_templates/autoapi/python/class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,20 @@

{% set show_obj_args = False %}

.. py:{{ obj.type }}:: {% if is_own_page %}{{ obj.id }}{% else %}{{ obj.short_name }}{% endif %}{% if show_obj_args %}({{ obj.args }}){% endif %}
{% if is_own_page %}
.. py:currentmodule:: {{ obj.id.replace('.' + obj.name, '') }}
{% endif %}

.. py:{{ obj.type }}:: {% if is_own_page %}{{ obj.name }}{% else %}{{ obj.short_name }}{% endif %}{% if show_obj_args %}({{ obj.args }}){% endif %}
:canonical: {{ obj.id }}

{% for (args, return_annotation) in obj.overloads %}
{{ " " * (obj.type | length) }} {{ obj.short_name }}{% if args %}({{ args }}){% endif %}

{% endfor %}

{% if is_own_page %}
.. py:currentmodule:: {{ obj.id.replace('.' + obj.name, '') }}
{% endif %}

{% if obj.bases %}
{% if "show-inheritance" in autoapi_options %}

Expand Down
21 changes: 11 additions & 10 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,25 @@
TRAC: The Modern Model Platform
###############################

TRAC is a universal model orchestration solution designed for the most complex, critical and highly-governed
use cases.
TRAC is a universal model orchestration solution for managing the most complex, critical and highly governed workflows.

The core platform services - i.e. TRAC Data & Analytics Platform (or TRAC D.A.P.) - are maintained by
`finTRAC Limited <https://www.fintrac.co.uk>`_ in association with the `finos Foundation <https://www.finos.org>`_
under the `Apache Software License version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.

This documentation site focuses on how to deploy the TRAC D.A.P. services and build both models and
applications which leverage those services. Commercially supported deployments of TRAC are separately
available from `finTRAC Limited <https://www.fintrac.co.uk>`_.
TRAC D.A.P. is the open-source data & analytics toolkit which provides the core capabilities of TRAC.
It is maintained by `finTRAC Limited <https://fintrac.co.uk/>`_
in association with `FINOS <https://www.finos.org/>`_
and is available to download and use for free under the
`Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.

This documentation describes how to build models and client applications using the TRAC D.A.P. toolkit.
Commercially supported deployments of the TRAC platform are available separately from
`finTRAC Limited <https://www.fintrac.co.uk>`_.

.. note::
You can see the current development status of TRAC D.A.P. and a roadmap for the platform on the
You can see the current development status of TRAC D.A.P. and a roadmap for the platform on the
`roadmap page <https://github.com/finos/tracdap/wiki/Development-Roadmap>`_.
If you have particular questions or issues, please raise a ticket on our
`issue tracker <https://github.com/finos/tracdap/issues>`_.


.. grid:: 1 2 2 2
:gutter: 3

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<body>

<div class="trac_logo">
<img src="tracdap_horizontal_400.png" alt="TRAC Platform Logo">
<img src="tracmmp_horizontal_400.png" alt="TRAC Platform Logo">
</div>

</body>
Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
/*
* Copyright 2024 finTRAC Limited
*
* 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
* Licensed to the Fintech Open Source Foundation (FINOS) under one or
* more contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright ownership.
* FINOS licenses this file to you 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
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
/*
* Copyright 2024 finTRAC Limited
*
* 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
* Licensed to the Fintech Open Source Foundation (FINOS) under one or
* more contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright ownership.
* FINOS licenses this file to you 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
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
/*
* Copyright 2024 finTRAC Limited
*
* 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
* Licensed to the Fintech Open Source Foundation (FINOS) under one or
* more contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright ownership.
* FINOS licenses this file to you 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
*
Expand Down

0 comments on commit 106158c

Please sign in to comment.